Push

Start a Live Activity

Changed on

Starts an iOS Live Activity remotely (push-to-start, iOS 17.2+) on every device of one contact that reported a push-to-start token for activityType. Sequenzy adds sequenzy.activityId to the attributes so the SDK can report the new activity's update token under your id. Returns 202 with tokenCount 0, sending nothing, when no device can start it. Calling it again starts another copy. Requires the transactional:send scope.

post/push/live-activities/start

Request

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

Request body

emailstring

Contact whose devices start the activity. Provide email or subscriberId.

subscriberIdstring
activityTypestring required

The Swift ActivityAttributes type name, sent to APNs as attributes-type.

activityIdstring required

Your id for the activity, chosen when it starts.

attributesobject

Static attributes as JSON. A sequenzy key you send is replaced.

contentStateobject required

Your Swift ContentState as JSON. Date fields decode as seconds since 2001-01-01 unless your struct decodes them differently.

relevanceScorenumber

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

Example request

{
  "activityType": "DeliveryAttributes",
  "activityId": "order-1234",
  "attributes": {
    "orderNumber": "1234"
  },
  "contentState": {
    "status": "out_for_delivery",
    "minutesAway": 8
  },
  "alert": {
    "title": "Your order is on its way",
    "body": "Arriving in about 8 minutes."
  },
  "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