Templates
Templates — 10 operations (GET /v1/apps/{appId}/templates, POST /v1/apps/{appId}/templates, GET /v1/apps/{appId}/templates/{templateId}, …). Generated from the OpenAPI 3.1.0 contract.
Versioned message templates (Liquid), rollback, preview and template statistics.
Base URL: https://api.pushizo.com · Tag: templates · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/templates | List templates |
POST | /v1/apps/{appId}/templates | Create a template |
GET | /v1/apps/{appId}/templates/{templateId} | Template details |
PATCH | /v1/apps/{appId}/templates/{templateId} | Update a template |
DELETE | /v1/apps/{appId}/templates/{templateId} | Delete a template |
GET | /v1/apps/{appId}/templates/{templateId}/stats | Template analytics |
POST | /v1/apps/{appId}/templates/{templateId}/copy_to_app | Copy the template to another app in the same organization |
GET | /v1/apps/{appId}/templates/{templateId}/versions | Version history |
POST | /v1/apps/{appId}/templates/{templateId}/versions/{version}/revert | Make an earlier version the current one |
POST | /v1/apps/{appId}/templates/{templateId}/render | Render the template with sample data |
Details
List templates
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
q | query | string | No | Length: 1–100 | "ayse" |
channel | query | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" | "ios_push" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: TemplatePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].channel | enum | null | Yes | |
data[].current_version | integer | Yes | |
data[].tags | array<string> | Yes | |
data[].content | map<string, any> | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": 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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/templates?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a template
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: CreateTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
channel | enum | null | No | |
tags | array<string> | No | Items: 0–20 |
content | object | Yes | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_template.button_params[].index | integer | Yes | Range: 0–9 |
content.whatsapp_template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
content.whatsapp_template.button_params[].value | string | Yes | Length: 1–256 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.buttons[].id | string | Yes | Length: 1–256 |
content.whatsapp_interactive.buttons[].title | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list | object | No | |
content.whatsapp_interactive.list.button | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list.sections | array<object> | Yes | Items: 1–10 |
content.whatsapp_interactive.list.sections[].title | string | No | Length: 1–24 |
content.whatsapp_interactive.list.sections[].rows | array<object> | Yes | Items: 1–10 |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
},
"channel": "ios_push",
"tags": [
"plan:pro"
]
}Responses
200 — Success.
Schema: Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"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/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
},
"channel": "ios_push",
"tags": [
"plan:pro"
]
}'Template details
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a template
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
channel | enum | null | No | |
tags | array<string> | No | Items: 0–20 |
content | object | No | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_template.button_params[].index | integer | Yes | Range: 0–9 |
content.whatsapp_template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
content.whatsapp_template.button_params[].value | string | Yes | Length: 1–256 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.buttons[].id | string | Yes | Length: 1–256 |
content.whatsapp_interactive.buttons[].title | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list | object | No | |
content.whatsapp_interactive.list.button | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list.sections | array<object> | Yes | Items: 1–10 |
content.whatsapp_interactive.list.sections[].title | string | No | Length: 1–24 |
content.whatsapp_interactive.list.sections[].rows | array<object> | Yes | Items: 1–10 |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
}
}Responses
200 — Success.
Schema: Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
}
}'Delete a template
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| 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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Template analytics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: TemplateStats
| Field | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | |
messages | integer | Yes | |
campaigns | integer | Yes | |
targeted | integer | Yes | |
sent | integer | Yes | |
delivered | integer | Yes | |
opened | integer | Yes | |
clicked | integer | Yes | |
converted | integer | Yes | |
open_rate | number | Yes | |
click_rate | number | Yes | |
conversion_rate | number | Yes | |
last_used_at | string | null | Yes |
Example response:
{
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"messages": 1,
"campaigns": 1,
"targeted": 1,
"sent": 1,
"delivered": 1,
"opened": 1,
"clicked": 1,
"converted": 1,
"open_rate": 1.5,
"click_rate": 1.5,
"conversion_rate": 1.5,
"last_used_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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W/stats" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Copy the template to another app in the same organization
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CopyTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
target_app_id | string | Yes | Length: 1–64 |
name | string | No | Length: 2–100 |
Example:
{
"target_app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"name": "Sipariş bildirimleri"
}Responses
201 — Success.
Schema: Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W/copy_to_app" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target_app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"name": "Sipariş bildirimleri"
}'Version history
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: TemplateVersionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].version | integer | Yes | |
data[].content | map<string, any> | Yes | |
data[].created_by | string | null | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"created_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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Make an earlier version the current one
/v1/apps/{appId}/templates/{templateId}/versions/{version}/revertTry it (interactive API docs, new tab)Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
version | path | string | Yes | "örnek" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Template
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
channel | enum | null | Yes | |
current_version | integer | Yes | |
tags | array<string> | Yes | |
content | map<string, any> | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channel": "ios_push",
"tags": [
"plan:pro"
],
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"current_version": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"created_by": "örnek",
"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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W/versions/örnek/revert" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Render the template with sample data
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
templateId | path | string | Yes | "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: RenderTemplateDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"; Default: "ios_push" |
language | string | No | Length: 2–10 |
user | object | No | |
user.external_id | string | No | Length: 0–255 |
user.tags | map<string, string> | No | |
user.properties | map<string, any> | No | |
custom_data | map<string, any> | No | |
content | object | No | |
content.headings | map<string, string> | No | |
content.contents | map<string, string> | No | |
content.subtitle | map<string, string> | No | |
content.url | string (url) | No | Length: 0–2000 |
content.app_url | string (url) | No | Length: 0–2000 |
content.data | map<string, string> | No | |
content.buttons | array<object> | No | Items: 0–3 |
content.buttons[].id | string | Yes | Length: 1–64 |
content.buttons[].text | string | Yes | Length: 1–100 |
content.buttons[].icon | string (url) | No | Length: 0–2000 |
content.buttons[].url | string (url) | No | Length: 0–2000 |
content.big_picture | string (url) | No | Length: 0–2000 |
content.ios_attachments | map<string, string (url)> | No | |
content.ios_sound | string | No | Length: 0–100 |
content.ios_badge_type | enum | No | Values: "None", "SetTo", "Increase" |
content.ios_badge_count | integer | No | Range: 0–99999 |
content.ios_interruption_level | enum | No | Values: "passive", "active", "time-sensitive", "critical" |
content.ios_category | string | No | Length: 0–100 |
content.android_channel_id | string | No | Length: 0–100 |
content.android_group | string | No | Length: 0–100 |
content.android_sound | string | No | Length: 0–100 |
content.chrome_web_icon | string (url) | No | Length: 0–2000 |
content.chrome_web_image | string (url) | No | Length: 0–2000 |
content.chrome_web_badge | string (url) | No | Length: 0–2000 |
content.web_push_topic | string | No | Length: 0–32 |
content.content_available | boolean | No | |
content.mutable_content | boolean | No | |
content.custom_data | map<string, any> | No | |
content.email_subject | string | No | Length: 0–998 |
content.email_body | string | No | Length: 0–500000 |
content.email_mjml | string | No | Length: 0–500000 |
content.email_preheader | string | No | Length: 0–500 |
content.email_from_name | string | No | Length: 0–200 |
content.email_from_address | string (email) | No | Length: 0–320 |
content.email_reply_to_address | string (email) | No | Length: 0–320 |
content.disable_email_click_tracking | boolean | No | |
content.sms_from | string | No | Length: 1–20 |
content.disable_sms_link_shortening | boolean | No | |
content.add_to_inbox | boolean | No | |
content.inbox_ttl | integer | No | Range: 60–31536000 |
content.content_card | object | No | |
content.content_card.type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
content.content_card.pinned | boolean | No | |
content.content_card.priority | integer | No | Range: 0–100 |
content.content_card.button_text | map<string, string> | No | |
content.thread_id | string | No | Length: 0–100 |
content.ios_relevance_score | number | No | Range: 0–1 |
content.target_content_identifier | string | No | Length: 0–200 |
content.small_icon | string | No | Length: 0–100 |
content.large_icon | string (url) | string | No | |
content.android_accent_color | string | No | |
content.android_visibility | 1 | 0 | -1 | No | |
content.web_buttons | array<object> | No | Items: 0–2 |
content.web_buttons[].id | string | Yes | Length: 1–64 |
content.web_buttons[].text | string | Yes | Length: 1–100 |
content.web_buttons[].icon | string (url) | No | Length: 0–2000 |
content.web_buttons[].url | string (url) | No | Length: 0–2000 |
content.require_interaction | boolean | No | |
content.sms_media_urls | array<string (url)> | No | Items: 1–10 |
content.whatsapp_template | object | No | |
content.whatsapp_template.name | string | Yes | |
content.whatsapp_template.language | string | Yes | |
content.whatsapp_template.header | object | No | |
content.whatsapp_template.body_params | array<string> | No | Items: 0–20 |
content.whatsapp_template.button_params | array<object> | No | Items: 0–10 |
content.whatsapp_template.button_params[].index | integer | Yes | Range: 0–9 |
content.whatsapp_template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
content.whatsapp_template.button_params[].value | string | Yes | Length: 1–256 |
content.whatsapp_media | object | No | |
content.whatsapp_media.type | enum | Yes | Values: "image", "video", "document", "audio" |
content.whatsapp_media.url | string (url) | Yes | Length: 0–2000 |
content.whatsapp_media.filename | string | No | Length: 1–240 |
content.whatsapp_interactive | object | No | |
content.whatsapp_interactive.type | enum | Yes | Values: "button", "list" |
content.whatsapp_interactive.header | string | No | Length: 1–60 |
content.whatsapp_interactive.footer | string | No | Length: 1–60 |
content.whatsapp_interactive.buttons | array<object> | No | Items: 1–3 |
content.whatsapp_interactive.buttons[].id | string | Yes | Length: 1–256 |
content.whatsapp_interactive.buttons[].title | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list | object | No | |
content.whatsapp_interactive.list.button | string | Yes | Length: 1–20 |
content.whatsapp_interactive.list.sections | array<object> | Yes | Items: 1–10 |
content.whatsapp_interactive.list.sections[].title | string | No | Length: 1–24 |
content.whatsapp_interactive.list.sections[].rows | array<object> | Yes | Items: 1–10 |
content.rcs_card | object | No | |
content.rcs_card.title | map<string, string> | No | |
content.rcs_card.description | map<string, string> | No | |
content.rcs_card.media_url | string (url) | No | Length: 0–2000 |
content.rcs_card.media_height | enum | No | Values: "SHORT", "MEDIUM", "TALL" |
content.rcs_card.orientation | enum | No | Values: "VERTICAL", "HORIZONTAL" |
content.rcs_suggestions | array<object> | No | Items: 0–11 |
content.rcs_content_sid | string | No | |
content.rcs_content_variables | map<string, string> | No | |
content.rcs_fallback_text | map<string, string> | No | |
content.messenger_image_url | string (url) | No | Length: 0–2000 |
content.messenger_buttons | array<object> | No | Items: 0–6 |
content.ios_carousel | array<object> | No | Items: 0–5 |
content.ios_carousel[].url | string (url) | Yes | Length: 0–2000 |
content.ios_carousel[].title | string | No | Length: 0–80 |
content.android_live_update | object | No | |
content.android_live_update.progress | integer | Yes | Range: 0–100 |
content.android_live_update.ongoing | boolean | No | |
content.voip | boolean | No | |
content.app_clip | boolean | No | |
version | integer | No | Range: 1–∞ |
Example:
{
"channel": "ios_push",
"language": "tr",
"user": {
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"external_id": "user_42"
},
"custom_data": {
"key": "örnek"
},
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
}
}Responses
200 — Success.
Schema: RenderPreview
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
language | string | Yes | |
title | string | null | Yes | |
subtitle | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
icon_url | string | null | Yes | |
buttons | array<object> | Yes | |
buttons[].id | string | Yes | |
buttons[].text | string | Yes | |
buttons[].url | string | null | Yes | |
data | map<string, string> | Yes | |
warnings | array<string> | Yes | |
email | object | null | No | |
sms | object | null | No |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"channel": "ios_push",
"language": "tr",
"title": "Siparişiniz yola çıktı",
"subtitle": "örnek",
"body": "Takip bağlantısı içeride",
"image_url": "https://pushizo.com/orders/1001",
"icon_url": "https://pushizo.com/orders/1001",
"buttons": [
{
"url": "https://pushizo.com/orders/1001",
"id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": "Takip bağlantısı içeride"
}
],
"warnings": [
"örnek"
],
"email": {
"subject": "Siparişiniz yola çıktı",
"preheader": "örnek",
"html": "örnek",
"text": "Takip bağlantısı içeride"
},
"sms": {
"body": "Takip bağlantısı içeride",
"encoding": "gsm7",
"characters": 1,
"segments": 1,
"per_segment": 1,
"non_gsm_characters": [
"örnek"
],
"turkish_characters": [
"ö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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W/render" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "ios_push",
"language": "tr",
"user": {
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"external_id": "user_42"
},
"custom_data": {
"key": "örnek"
},
"content": {
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001"
}
}'Segments
Segments — 34 operations (GET /v1/apps/{appId}/geofences, POST /v1/apps/{appId}/geofences, GET /v1/apps/{appId}/geofences/{geofenceId}, …). Generated from the OpenAPI 3.1.0 contract.
Campaigns
Campaigns — 28 operations (GET /v1/apps/{appId}/custom-agents, POST /v1/apps/{appId}/custom-agents, GET /v1/apps/{appId}/custom-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.