Start Live Activity
/messages/live_activity/start
Use this endpoint to remotely start Live Activities displayed in your iOS app. This endpoint requires additional setup.
After you create a Live Activity, make a POST request to target a segment, a connected audience, or specific users. Identify specific users by external user ID, user alias, or both. For more information about Apple’s Live Activities, see Starting and updating Live Activities with ActivityKit push notifications.
If content-available isn’t set, the default Apple Push Notification service (APNs) priority is 10. If content-available is set, this priority is 5. For more information, see Apple push object.
After a successful /messages/live_activity/start request, wait at least 5 minutes before you send the first /messages/live_activity/update request for the same activity_id. This delay gives Braze and APNs time to register the new Live Activity and its token mapping. If you send the first update too soon, that update may not apply to the activity.
To end a Live Activity, use the /messages/live_activity/update endpoint with end_activity set to true.
Arranging automatic dismissal
To arrange automatic dismissal after a Live Activity starts, schedule a follow-up request to the update endpoint from your backend.
- Send a
/messages/live_activity/startrequest with anactivity_idyou can reuse later. - Store that
activity_idand your target end time in your backend scheduler. - At the target end time, send a
/messages/live_activity/updaterequest withend_activityset totrue. - Configure dismissal behavior in the same update request. For details, see the
/messages/live_activity/updateendpoint. - Verify send and outcome events in the Message Activity Log.
Endpoint reference
This reference is generated from the OpenAPI specification for this endpoint. To run the endpoint, copy the generated cURL example and send it from your terminal or Postman. You can also download the raw OpenAPI spec for this page at /docs/assets/api/openapi/messaging_live_activity_start.yaml. Use this spec to validate that your requests include the correct parameters, fields, and structure before you send them. To learn how, see Use OpenAPI schemas for request validation.