/liveActivity/end

post

https://api.dengage.com/rest/liveActivity/end

Ends an active Live Activity. In addition to signaling the end, this request also delivers a final content update to all current recipients — the iosPayload and androidPayload provided here update the widget's content before it closes.

endDateUtc behavior:

If provided, the activity remains visible on both platforms until the specified time. Must be sent as UTC.
If omitted, the activity closes immediately on both platforms (equivalent to passing the current UTC time).

Note: A Live Activity expires 13 hours after it was started. End operations are only allowed within this window.

REST-layer validations — HTTP 400, internal code 11:

Field	Rule	Error message
`activityId`	Required	`ActivityId is required`
`activityId`	Activity has ended and is waiting to expire	`ActivityId '{activityId}' has been ended and is scheduled to close on {endDateUtc} (UTC). No further operations are allowed until it expires.`
`activityId`	No active subscribers (expired or no permission granted)	`No active subscribers found for ActivityId: {id}. Users may not have granted permission for live activities or the activity has expired.`
`activityId`	Concurrent lock held — retryable	`Another operation is currently in progress for ActivityId '{id}'. Please try again shortly.`

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

activityId

string

required

Required. The activityId of the Live Activity to end. Must be an active activity (within the 13-hour TTL). Returns HTTP 400 if no active subscribers are found.

endDateUtc

date-time

UTC datetime until which the activity remains visible on the device after ending. Must be in UTC. If omitted, the activity closes immediately (equivalent to passing the current UTC time).

iosPayload

object

Optional iOS final state shown before the activity closes. Contains dynamic objects — send whatever fields your widget template expects.

contentState — final state data shown in the activity before it closes.
alert — optional alert shown when the activity ends.
attributes — static attributes for the activity. Fields depend on your app's template.

androidPayload

object

Optional Android final state. Fully dynamic object — send whatever fields your widget template expects.

traceId

uuid

Optional idempotency key. See Rest API Idempotency tag for details.

Headers

Authorization

string

required

Defaults to {$$.env.access_token}

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Request accepted. Per-device delivery results are available in the Live Activity Report.

400Validation error. Internal code is always 11. The Another operation is currently in progress error is retryable — wait a moment and resend the request.

403Forbidden. Internal code is 10. Returned when the caller lacks the required role or the Live Activity feature is not enabled for the account.

409Duplicate request detected via traceId idempotency check. Internal code is 409.