End a Live Activity for all subscribed devices

This endpoint stops an ongoing Live Activity (liveExternalId) for all devices subscribed to this Live Activity. You can send final information and change parameters. You can also decide how long you need to have the Live Activity active on the devices before ending.

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

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.

number
≥ 0

Seconds to leave the notification visible. If it is 0, it closes immediately. If it is not sent, the default is 4 hours.

Responses

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