> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sequenzy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# End a Live Activity

> End a contact's Live Activity on every device running it

Ends a contact's activity on every device running it. Each token is marked `ended` once APNs accepts the push, so you can send an end again if one failed. Requires the `transactional:send` scope.

Without `dismissalDate`, iOS keeps an ended activity on the Lock Screen for up to four hours. Pass `0` or a past date to remove it right away.

## Request

**activityId** `string` *required*

The activity to end.

**email** `string`

Contact whose activity it is. Provide `email` or `subscriberId`.

**subscriberId** `string`

Subscriber whose activity it is.

**contentState** `object` *required*

Final content shown until the activity is removed. Apple's end payloads
always include it, and iOS can drop an end without it.

**dismissalDate** `integer | string`

When to remove it: Unix seconds or an ISO 8601 date.

**alert** `object`

Optional `title`, `body` and `sound`.

**priority** `string` (default: high)

`high` or `low`, as for updates.

**staleDate** `integer | string`

Unix seconds or an ISO 8601 date.

**relevanceScore** `number`

Orders a person's concurrent activities.

```bash theme={null}
curl -X POST "https://api.sequenzy.com/api/v1/push/live-activities/end" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"email":"jane@example.com","activityId":"order-1234","contentState":{"status":"delivered","minutesAway":0},"dismissalDate":"2026-10-20T18:00:00Z"}'
```

## Responses

A body with a missing or mistyped field is rejected with `422` before any other check; invalid ids, dates and the missing contact return `400`.

```json 202 theme={null}
{
  "success": true,
  "event": "end",
  "activityId": "order-1234",
  "tokenCount": 1,
  "jobIds": ["liveact-0d2e-0"],
  "message": "End queued for 1 device."
}
```

```json 400 theme={null}
{
  "error": "dismissalDate: Use Unix seconds or an ISO 8601 date"
}
```

```json 401 theme={null}
{
  "error": "Invalid API key"
}
```

```json 422 theme={null}
{ "success": false, "error": "Expected property 'contentState' to be object" }
```

```json 403 theme={null}
{
  "error": "API key is missing required scope: transactional:send"
}
```

```json 404 theme={null}
{
  "error": "Subscriber not found."
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.