Initialize a Live Activity for all subscribed devices

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

Customer application id

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.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json