iOS Live Activities
iOS Live Activities — 7 operations (GET /v1/apps/{appId}/live-activities/types, POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}, …). Generated from the OpenAPI 3.1.0 contract.
iOS Live Activities: activity type registration, schema validation and start/update/end pushes.
Base URL: https://api.pushizo.com · Tag: live-activities · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/live-activities/types | Live Activity types |
POST | /v1/apps/{appId}/live-activities/types | Create a Live Activity type |
PATCH | /v1/apps/{appId}/live-activities/types/{activityType} | Update a Live Activity type |
DELETE | /v1/apps/{appId}/live-activities/types/{activityType} | Delete a Live Activity type |
POST | /v1/apps/{appId}/live-activities/{activityType}/start | Start a Live Activity (push-to-start) |
POST | /v1/apps/{appId}/live-activities/{activityType}/update | Update a Live Activity |
POST | /v1/apps/{appId}/live-activities/{activityType}/end | End a Live Activity |
Details
Live Activity types
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: LiveActivityTypeList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].content_state_schema | object | Yes | |
data[].content_state_schema.type | "object" | Yes | |
data[].content_state_schema.properties | map<string, object> | Yes | |
data[].content_state_schema.required | array<string> | No | Items: 0–50 |
data[].attributes_schema | object | Yes | |
data[].attributes_schema.type | "object" | Yes | |
data[].attributes_schema.properties | map<string, object> | Yes | |
data[].attributes_schema.required | array<string> | No | Items: 0–50 |
data[].push_to_start_tokens | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"push_to_start_tokens": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a Live Activity type
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateLiveActivityTypeDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–100 |
description | string | No | Length: 0–300 |
content_state_schema | object | Yes | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | No | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
Example:
{
"name": "Sipariş bildirimleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"description": "Sipariş durumu güncellemeleri",
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
}
}Responses
201 — Success.
Schema: LiveActivityType
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
content_state_schema | object | Yes | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | Yes | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
push_to_start_tokens | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"push_to_start_tokens": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"description": "Sipariş durumu güncellemeleri",
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
}
}'Update a Live Activity type
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
activityType | path | string | Yes | "order_tracking" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateLiveActivityTypeDto
| Field | Type | Required | Description |
|---|---|---|---|
description | string | null | No | |
content_state_schema | object | No | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | No | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
Example:
{
"description": "Sipariş durumu güncellemeleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
}
}Responses
200 — Success.
Schema: LiveActivityType
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
content_state_schema | object | Yes | |
content_state_schema.type | "object" | Yes | |
content_state_schema.properties | map<string, object> | Yes | |
content_state_schema.required | array<string> | No | Items: 0–50 |
attributes_schema | object | Yes | |
attributes_schema.type | "object" | Yes | |
attributes_schema.properties | map<string, object> | Yes | |
attributes_schema.required | array<string> | No | Items: 0–50 |
push_to_start_tokens | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "typ_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"push_to_start_tokens": 1,
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types/order_tracking" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"description": "Sipariş durumu güncellemeleri",
"content_state_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
},
"attributes_schema": {
"properties": {
"order_id": "1001"
},
"type": "object",
"required": [
"örnek"
]
}
}'Delete a Live Activity type
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
activityType | path | string | Yes | "order_tracking" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: LiveActivityTokenResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/types/order_tracking" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Start a Live Activity (push-to-start)
Starts the activity remotely using the push-to-start tokens of the targeted iOS subscriptions (iOS 17.2+). attributes and content_state must match the type's schema. Use the returned activity_id for subsequent update/end calls.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
activityType | path | string | Yes | "order_tracking" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: StartLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | No | Length: 1–100 |
attributes | map<string, string | number | boolean> | No | |
target | object | Yes | |
target.include_external_ids | array<string> | No | Items: 0–2000 |
target.include_subscription_ids | array<string> | No | Items: 0–2000 |
target.included_segments | array<string> | No | Items: 0–20 |
target.all | boolean | No | |
content_state | map<string, string | number | boolean> | Yes | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Example:
{
"target": {
"include_external_ids": [
"user_42"
],
"include_subscription_ids": [
"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"included_segments": [
"örnek"
]
},
"content_state": {
"key": "user_42"
},
"name": "Sipariş bildirimleri",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"attributes": {
"key": "user_42"
},
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1
}Responses
202 — Success.
Schema: LiveActivitySendResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | |
activity_id | string | Yes | |
event | enum | Yes | Values: "start", "update", "end" |
recipients_estimate | integer | Yes |
Example response:
{
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event": "start",
"recipients_estimate": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/order_tracking/start" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target": {
"include_external_ids": [
"user_42"
],
"include_subscription_ids": [
"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"included_segments": [
"örnek"
]
},
"content_state": {
"key": "user_42"
},
"name": "Sipariş bildirimleri",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"attributes": {
"key": "user_42"
},
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1
}'Update a Live Activity
Sends a new content state to the update tokens reported by devices for the activity. Quiet hours and frequency caps are not applied; priority 5 preserves the Apple budget.
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
activityType | path | string | Yes | "order_tracking" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | Yes | Length: 1–100 |
content_state | map<string, string | number | boolean> | Yes | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Example:
{
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"content_state": {
"key": "user_42"
},
"name": "Sipariş bildirimleri",
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1,
"dismissal_date": 1,
"relevance_score": 1.5
}Responses
202 — Success.
Schema: LiveActivitySendResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | |
activity_id | string | Yes | |
event | enum | Yes | Values: "start", "update", "end" |
recipients_estimate | integer | Yes |
Example response:
{
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event": "start",
"recipients_estimate": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/order_tracking/update" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"content_state": {
"key": "user_42"
},
"name": "Sipariş bildirimleri",
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1,
"dismissal_date": 1,
"relevance_score": 1.5
}'End a Live Activity
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
activityType | path | string | Yes | "order_tracking" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: EndLiveActivityDto
| Field | Type | Required | Description |
|---|---|---|---|
activity_id | string | Yes | Length: 1–100 |
content_state | map<string, string | number | boolean> | No | |
alert | object | No | |
alert.title | map<string, string> | No | |
alert.body | map<string, string> | No | |
alert.sound | string | No | Length: 0–100 |
stale_date | integer | No | Range: 0–4102444800 |
dismissal_date | integer | No | Range: 0–4102444800 |
relevance_score | number | No | Range: 0–1 |
priority | 5 | 10 | No | |
name | string | No | Length: 0–200 |
Example:
{
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"name": "Sipariş bildirimleri",
"content_state": {
"key": "user_42"
},
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1,
"dismissal_date": 1
}Responses
202 — Success.
Schema: LiveActivitySendResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | Yes | |
activity_id | string | Yes | |
event | enum | Yes | Values: "start", "update", "end" |
recipients_estimate | integer | Yes |
Example response:
{
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"event": "start",
"recipients_estimate": 1
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/order_tracking/end" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"name": "Sipariş bildirimleri",
"content_state": {
"key": "user_42"
},
"alert": {
"title": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"body": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"sound": "örnek"
},
"stale_date": 1,
"dismissal_date": 1
}'Suppression list
Suppression list — 3 operations (GET /v1/apps/{appId}/suppressions, POST /v1/apps/{appId}/suppressions, DELETE /v1/apps/{appId}/suppressions/{suppressionId}). Generated from the OpenAPI 3.1.0 contract.
Conversations (live chat, WhatsApp, SMS, email)
Conversations (live chat, WhatsApp, SMS, email) — 24 operations (GET /v1/apps/{appId}/ai-agents, POST /v1/apps/{appId}/ai-agents, GET /v1/apps/{appId}/ai-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.