Skip to main content
POST
Start one real Live Activity test bound to its owner, selected project and one device.
This endpoint requires push.test.send, an explicitly selected project, app, and registered device. The server generates test_id; the test remains bound to its creator, project, app, and device. Save that handle for inspection, updates, and ending. The test delivers a real notification; provider acceptance does not prove display.

Authorizations

Authorization
string
header
required

Integration key for backend workloads, or a scoped personal key (sr_user_) for account discovery and supported project operations. MCP accepts only personal keys.

Headers

X-Sendrealm-Project-Id
string<uuid>

Explicit project context. Required for personal-key project resource calls; integration keys retain their configured default. MCP clients supply project_id in each tool call instead.

Body

application/json
app_id
string
required

Push app short ID or resource UUID.

device_id
string
required

Registered device identifier.

activity_type
string

Native activity type.

attributes_type
string

Native activity attributes type.

title
string

Activity title.

subtitle
string

Activity subtitle.

body
string

Activity message.

status
string

Application status.

progress
number
Required range: 0 <= x <= 1
eta
string

Application ETA.

image_url
string<uri>

Image URL.

accent_color
string

Accent color.

launch_url
string

Tap destination.

content_state
object
attributes
object
priority
enum<integer>
Available options:
5,
10
stale_at
string<date-time>

ISO 8601 stale time.

dismiss_at
string<date-time>

ISO 8601 dismiss time.

relevance_score
number
Required range: 0 <= x <= 1
sound
string

Native sound.

data
object
stale_date
string<date-time>

Legacy alias for stale_at.

dismissal_date
string<date-time>

Legacy alias for dismiss_at.

buttons
object[]

Native activity buttons.

Maximum array length: 3

Response

Successful response

data
object
required
status
integer
metadata
object
{key}