Skip to main content
POST
/
live-activity
/
broadcast
/
end
End Broadcast Live Activity
curl --request POST \
  --url https://api-0{dc}.moengage.com/v1.0/live-activity/broadcast/end \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'X-Broadcast-Live-Activity-Id: <x-broadcast-live-activity-id>' \
  --header 'X-MOE-APPKEY: <api-key>' \
  --data '
{
  "broadcast_live_activity_id": "<string>",
  "ios": {
    "content_state": {},
    "alert": {
      "title": "<string>",
      "body": "<string>",
      "subtitle": "<string>",
      "sound": "<string>"
    },
    "dismissal_date": 123,
    "stale_date": 123
  },
  "instance_id": "<string>"
}
'
{ "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.

Headers

​
X-Broadcast-Live-Activity-Id
string
required

The unique identifier for the broadcast Live Activity campaign being ended.

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

Body

application/json

The payload containing the final content state and dismissal information for the Live Activity.

Rate Limit

The rate limit for this endpoint is 500 requests per minute per workspace and 5 requests per minute per live activity ID.

​
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. Sample value:1749822841120-57c5c617. Optional unique identifier for this specific broadcast instance.

Response

Success. The live activity was ended.

​
data
object