Skip to main content
POST
/
live-activity
/
broadcast
/
start
Start Broadcast Live Activity
curl --request POST \
  --url https://api-{dc}.moengage.com/v1.0/live-activity/broadcast/start \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'X-MOE-APPKEY: <x-moe-appkey>' \
  --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>"
}
'
{
  "data": {
    "instance_id": "1749822841120-57c5c617",
    "message": "success"
  }
}
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.

​
Rate Limit

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

Authorizations

​
Authorization
string
header
required

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

  • Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
  • Password: Use your API Key, which you can find within the Push tile.

For more information on authentication and getting your credentials, refer here.

Headers

​
X-MOE-APPKEY
string
required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

Body

application/json

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

​
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.

​
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

Success. The live activity instance was created.

​
data
object