PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/live-activities/typesLive Activity types
POST/v1/apps/{appId}/live-activities/typesCreate 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}/startStart a Live Activity (push-to-start)
POST/v1/apps/{appId}/live-activities/{activityType}/updateUpdate a Live Activity
POST/v1/apps/{appId}/live-activities/{activityType}/endEnd a Live Activity

Details

Live Activity types

GET/v1/apps/{appId}/live-activities/typesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LiveActivityTypeList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].content_state_schemaobjectYes
data[].content_state_schema.type"object"Yes
data[].content_state_schema.propertiesmap<string, object>Yes
data[].content_state_schema.requiredarray<string>NoItems: 0–50
data[].attributes_schemaobjectYes
data[].attributes_schema.type"object"Yes
data[].attributes_schema.propertiesmap<string, object>Yes
data[].attributes_schema.requiredarray<string>NoItems: 0–50
data[].push_to_start_tokensintegerYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/live-activities/typesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateLiveActivityTypeDto

FieldTypeRequiredDescription
namestringYesLength: 1–100
descriptionstringNoLength: 0–300
content_state_schemaobjectYes
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectNo
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
content_state_schemaobjectYes
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectYes
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 0–50
push_to_start_tokensintegerYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/live-activities/types/{activityType}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
activityTypepathstringYes"order_tracking"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateLiveActivityTypeDto

FieldTypeRequiredDescription
descriptionstring | nullNo
content_state_schemaobjectNo
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectNo
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
content_state_schemaobjectYes
content_state_schema.type"object"Yes
content_state_schema.propertiesmap<string, object>Yes
content_state_schema.requiredarray<string>NoItems: 0–50
attributes_schemaobjectYes
attributes_schema.type"object"Yes
attributes_schema.propertiesmap<string, object>Yes
attributes_schema.requiredarray<string>NoItems: 0–50
push_to_start_tokensintegerYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/live-activities/types/{activityType}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
activityTypepathstringYes"order_tracking"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: LiveActivityTokenResult

FieldTypeRequiredDescription
oktrueYes

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)

POST/v1/apps/{appId}/live-activities/{activityType}/startTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
activityTypepathstringYes"order_tracking"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: StartLiveActivityDto

FieldTypeRequiredDescription
activity_idstringNoLength: 1–100
attributesmap<string, string | number | boolean>No
targetobjectYes
target.include_external_idsarray<string>NoItems: 0–2000
target.include_subscription_idsarray<string>NoItems: 0–2000
target.included_segmentsarray<string>NoItems: 0–20
target.allbooleanNo
content_statemap<string, string | number | boolean>Yes
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 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

FieldTypeRequiredDescription
message_idstringYes
activity_idstringYes
eventenumYesValues: "start", "update", "end"
recipients_estimateintegerYes

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

POST/v1/apps/{appId}/live-activities/{activityType}/updateTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
activityTypepathstringYes"order_tracking"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateLiveActivityDto

FieldTypeRequiredDescription
activity_idstringYesLength: 1–100
content_statemap<string, string | number | boolean>Yes
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 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

FieldTypeRequiredDescription
message_idstringYes
activity_idstringYes
eventenumYesValues: "start", "update", "end"
recipients_estimateintegerYes

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

POST/v1/apps/{appId}/live-activities/{activityType}/endTry it (interactive API docs, new tab)

Authentication: API key — scope notifications:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
activityTypepathstringYes"order_tracking"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: EndLiveActivityDto

FieldTypeRequiredDescription
activity_idstringYesLength: 1–100
content_statemap<string, string | number | boolean>No
alertobjectNo
alert.titlemap<string, string>No
alert.bodymap<string, string>No
alert.soundstringNoLength: 0–100
stale_dateintegerNoRange: 0–4102444800
dismissal_dateintegerNoRange: 0–4102444800
relevance_scorenumberNoRange: 0–1
priority5 | 10No
namestringNoLength: 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

FieldTypeRequiredDescription
message_idstringYes
activity_idstringYes
eventenumYesValues: "start", "update", "end"
recipients_estimateintegerYes

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
}'

On this page