Use this endpoint to update the content of a running Live Activity, or to end it.

API at a glance

Description: Updates change the card in place rather than sending a fresh notification each time, so customers see the latest state without a stream of alerts building up. Use the same endpoint to end an activity by setting end_activity to true.

Address the activity with the bsft_activity_id you set as bsftActivityId when calling Start a Live Activity, together with the same activity_attributes_type. Both must match or the activity is not found.

Authentication & testing - Live Activities

Authorization: Basic encoded\_value

Postman collection

Try it with Postman: Explore the API using Blueshift's Postman collection.

Things to know before you start

• bsft_activity_id and activity_attributes_type must both match the values used to start the activity. If either differs, the activity is not found and nothing is delivered.
• Retry an update that returns Running Live Activity not found for any device. The device registers the activity with Blueshift shortly after it starts. An update sent before that completes returns this message. It is not a permanent failure.
• content_state property names must match your app. They must exactly match the ContentState your app defines. A mismatch is not reported as an error: the API returns a success response and the device discards the content.
• Omit notification to update silently. Include it only when a change is significant enough to alert the customer.
• Set end_activity to true to end the activity. It is removed from the Dynamic Island immediately and clears from the Lock Screen shortly after.
• Activities can be updated for up to 8 hours after they start. This is an Apple limit. For events that run longer, end the activity and start a new one for each stage.
• A 200 response means the push was dispatched, not displayed. Check dispatched_to and the errors array in the response.

Request parameters

Example requests & responses

  curl --request POST \
       --url https://api.getblueshift.com/api/v1/live_activity/update \
       --header 'accept: application/json' \
       --header 'authorization: Basic YWNlZDZlNGYxMWExYWVhOTZmNTJkNDg4M2ZmMjI4Mjg6' \
       --header 'content-type: application/json' \
       --data '
  {
    "customer_identifier_type": "email",
    "customer_identifiers": ["[email protected]"],
    "activity_attributes_type": "DeliveryActivityAttribute",
    "bsft_activity_id": "order_4482",
    "content_state": {
      "title": "Out for delivery",
      "subtitle": "Arriving by 6:45 PM",
      "progress": 0.7
    }
  }
  '

{
  "status": "ok",
  "dispatched_to": 1,
  "errors": []
}

  curl --request POST \
       --url https://api.getblueshift.com/api/v1/live_activity/update \
       --header 'accept: application/json' \
       --header 'authorization: Basic YWNlZDZlNGYxMWExYWVhOTZmNTJkNDg4M2ZmMjI4Mjg6' \
       --header 'content-type: application/json' \
       --data '
  {
    "customer_identifier_type": "email",
    "customer_identifiers": ["[email protected]"],
    "activity_attributes_type": "DeliveryActivityAttribute",
    "bsft_activity_id": "order_4482",
    "content_state": {
      "title": "Delivered",
      "subtitle": "Enjoy your order",
      "progress": 1.0
    },
    "end_activity": true
  }
  '

{
  "status": "ok",
  "dispatched_to": 1,
  "errors": []
}

{
  "status": "ok",
  "dispatched_to": 0,
  "errors": [
    {
      "customer_identifier_type": "email",
      "customer_identifier_value": "[email protected]",
      "error_message": "Running Live Activity not found for any device"
    }
  ]
}

Field reference