Start Broadcast Live Activity

Initiates a shared, real-time activity for a large audience, such as a live sporting match or real-time election result tracking.

You can start live activities for only push campaigns created with the BROADCAST_LIVE_ACTIVITY delivery type using the Create Push Campaigns API, not campaigns created through the MoEngage UI.

POST /live-activity/broadcast/start

Start Broadcast Live Activity

cURL

curl --request POST \
  --url https://api-0{dc}.moengage.com/v1.0/live-activity/broadcast/start \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'X-MOE-APPKEY: <api-key>' \
  --data '
{
  "broadcast_live_activity_id": "<string>",
  "ios": {
    "attribute_type": "LiveActivityAttributes",
    "attribute_info": {},
    "content_state": {},
    "alert": {
      "title": "<string>",
      "body": "<string>",
      "subtitle": "<string>",
      "sound": "<string>"
    },
    "dismissal_date": 123
  },
  "instance_id": "<string>"
}
'

200

Example

{ "data": { "instance_id": "1749822841120-57c5c617", "message": "success" } }

Authorizations

Authorization · string · header · required

This authentication parameter, used for access control, must be passed in the request. You can generate it using Workspace ID as username and Push API Key as password.

X-MOE-APPKEY · string · header · required

This is the workspace ID (earlier APP ID) of your MoEngage workspace. The X-MOE-APPKEY must be passed in the request. You can find your MoEngage Workspace ID in the MoEngage UI- Settings > Account > APIs -> Workspace ID (earlier app id)Your MoEngage Workspace ID.

Body

application/json

The configuration for starting the Live Activity, including the initial content and alert message.

Rate Limit

The rate limit for this endpoint is 5 requests per minute per workspace.

broadcast_live_activity_id · string · required

This field denotes the unique identifier for the broadcast Live Activity campaign. It links the broadcast request to a specific campaign previously created via the Create Push Campaigns API with the BROADCAST_LIVE_ACTIVITY delivery type.

ios · object · required

This field denotes a JSON object containing iOS-specific content, configuration details, and metadata necessary for managing the Live Activity on iOS devices.

Show child attributes

instance_id · string

This field denotes a unique, optional identifier for a specific instance of the Live Activity. It can be used to differentiate between multiple broadcasts of the same activity or to avoid duplicate requests. For example, '1749822841120-57c5c617'.

Response

200

application/json

Success. The live activity instance was created.

data · object

Show child attributes