SEsequenzy
Push

End a Live Activity

Changed on

Ends the contact's activity on every device running it. Tokens are marked ended as APNs accepts the push, so an end that failed can be sent again. Without dismissalDate iOS keeps an ended activity on the Lock Screen for up to four hours. Requires the transactional:send scope.

post/push/live-activities/end

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/push/live-activities/end
  • Auth
    HTTP bearer

Request body

emailstring

Contact whose activity it is. Provide email or subscriberId; activities are always addressed per contact, so a token registered under the same activityId by another device never receives this content.

subscriberIdstring

Subscriber whose activity it is.

activityIdstring required

Your id for the activity, chosen when it starts.

contentStateobject required

Final content shown until the activity is removed. Required, as in Apple's end payloads.

priority'high' | 'low'

high (default) delivers immediately and counts against Apple's Live Activity update budget; low (apns-priority 5) does not. Pushes with an alert always go at high priority.

relevanceScorenumber

Orders a person's concurrent activities; higher shows first.

Example request

{
  "activityId": "order-1234",
  "alert": {
    "title": "Your order is on its way",
    "body": "Arriving in about 8 minutes."
  },
  "dismissalDate": 1760979600,
  "staleDate": 1760979600
}

Response

Queued (or nothing to send when tokenCount is 0)

successboolean
event'start' | 'update' | 'end'
activityIdstring
tokenCountinteger

Devices the push was queued for. 0 means nothing was sent.

jobIdsstring[]

Queued delivery jobs, one per batch of 100 devices.

messagestring

Example response

{
  "activityId": "order-1234",
  "tokenCount": 1,
  "message": "Update queued for 1 device."
}

Changes