Initialize a Live Activity for all subscribed devices

post

https://api.indigitall.com/v2/pushlive/{appId}/activity/{liveExternalId}/send/all/start

This endpoint starts a Live Activity (liveExternalId) for all devices subscribed to this Live Activity.

Note: This functionality is supported on iOS devices running version 18 or later and on Android devices starting from version 5.0 (API 21)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

appId

number

required

Customer application id

liveExternalId

string

required

Live Activity External ID

Body Params

liveActivityEventData

object

required

Data properties to send live activity notification.
The total payload size should not exceed 3KB due to push provider limitations.

staticAttributes

object | null

This field overwrite staticAttributes values of live activity.
The dictionary that contains data you pass to a Live Activity that you start with a remote push notification with static data during the live activity cycle.
iOS platform should keep the same structure of your application and same structure that iosClass attributes.
For more information, see attributes in Official Apple Docs.

expirationSeconds

integer

≥ 0

Defaults to 600

Expiration in seconds for the START push notification while the device is offline.
If the device is offline and the START notification is not delivered within this window, the providers will discard it instead of storing it for later delivery.

Minimum: 0 (discard immediately if device is offline).
Default: 600 (10 minutes). This prevents stale Live Activities from starting when a device comes back online after a long period.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Live Activity Send Response

defaultError 5XX, 4XX