PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/templatesList templates
POST/v1/apps/{appId}/templatesCreate 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}/statsTemplate analytics
POST/v1/apps/{appId}/templates/{templateId}/copy_to_appCopy the template to another app in the same organization
GET/v1/apps/{appId}/templates/{templateId}/versionsVersion history
POST/v1/apps/{appId}/templates/{templateId}/versions/{version}/revertMake an earlier version the current one
POST/v1/apps/{appId}/templates/{templateId}/renderRender the template with sample data

Details

List templates

GET/v1/apps/{appId}/templatesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
qquerystringNoLength: 1–100"ayse"
channelqueryenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber""ios_push"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: TemplatePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].channelenum | nullYes
data[].current_versionintegerYes
data[].tagsarray<string>Yes
data[].contentmap<string, any>Yes
data[].created_bystring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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

POST/v1/apps/{appId}/templatesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateTemplateDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
channelenum | nullNo
tagsarray<string>NoItems: 0–20
contentobjectYes
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_template.button_params[].indexintegerYesRange: 0–9
content.whatsapp_template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
content.whatsapp_template.button_params[].valuestringYesLength: 1–256
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.buttons[].idstringYesLength: 1–256
content.whatsapp_interactive.buttons[].titlestringYesLength: 1–20
content.whatsapp_interactive.listobjectNo
content.whatsapp_interactive.list.buttonstringYesLength: 1–20
content.whatsapp_interactive.list.sectionsarray<object>YesItems: 1–10
content.whatsapp_interactive.list.sections[].titlestringNoLength: 1–24
content.whatsapp_interactive.list.sections[].rowsarray<object>YesItems: 1–10
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/templates/{templateId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Template

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/templates/{templateId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateTemplateDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
channelenum | nullNo
tagsarray<string>NoItems: 0–20
contentobjectNo
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_template.button_params[].indexintegerYesRange: 0–9
content.whatsapp_template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
content.whatsapp_template.button_params[].valuestringYesLength: 1–256
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.buttons[].idstringYesLength: 1–256
content.whatsapp_interactive.buttons[].titlestringYesLength: 1–20
content.whatsapp_interactive.listobjectNo
content.whatsapp_interactive.list.buttonstringYesLength: 1–20
content.whatsapp_interactive.list.sectionsarray<object>YesItems: 1–10
content.whatsapp_interactive.list.sections[].titlestringNoLength: 1–24
content.whatsapp_interactive.list.sections[].rowsarray<object>YesItems: 1–10
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/templates/{templateId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

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/templates/tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Template analytics

GET/v1/apps/{appId}/templates/{templateId}/statsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: TemplateStats

FieldTypeRequiredDescription
template_idstringYes
messagesintegerYes
campaignsintegerYes
targetedintegerYes
sentintegerYes
deliveredintegerYes
openedintegerYes
clickedintegerYes
convertedintegerYes
open_ratenumberYes
click_ratenumberYes
conversion_ratenumberYes
last_used_atstring | nullYes

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

POST/v1/apps/{appId}/templates/{templateId}/copy_to_appTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CopyTemplateDto

FieldTypeRequiredDescription
target_app_idstringYesLength: 1–64
namestringNoLength: 2–100

Example:

{
  "target_app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "name": "Sipariş bildirimleri"
}

Responses

201 — Success.

Schema: Template

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

GET/v1/apps/{appId}/templates/{templateId}/versionsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: TemplateVersionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].versionintegerYes
data[].contentmap<string, any>Yes
data[].created_bystring | nullYes
data[].created_atstringYes

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

POST/v1/apps/{appId}/templates/{templateId}/versions/{version}/revertTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
versionpathstringYes"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Template

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
channelenum | nullYes
current_versionintegerYes
tagsarray<string>Yes
contentmap<string, any>Yes
created_bystring | nullYes
created_atstringYes
updated_atstringYes

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

POST/v1/apps/{appId}/templates/{templateId}/renderTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
templateIdpathstringYes"tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: RenderTemplateDto

FieldTypeRequiredDescription
channelenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"; Default: "ios_push"
languagestringNoLength: 2–10
userobjectNo
user.external_idstringNoLength: 0–255
user.tagsmap<string, string>No
user.propertiesmap<string, any>No
custom_datamap<string, any>No
contentobjectNo
content.headingsmap<string, string>No
content.contentsmap<string, string>No
content.subtitlemap<string, string>No
content.urlstring (url)NoLength: 0–2000
content.app_urlstring (url)NoLength: 0–2000
content.datamap<string, string>No
content.buttonsarray<object>NoItems: 0–3
content.buttons[].idstringYesLength: 1–64
content.buttons[].textstringYesLength: 1–100
content.buttons[].iconstring (url)NoLength: 0–2000
content.buttons[].urlstring (url)NoLength: 0–2000
content.big_picturestring (url)NoLength: 0–2000
content.ios_attachmentsmap<string, string (url)>No
content.ios_soundstringNoLength: 0–100
content.ios_badge_typeenumNoValues: "None", "SetTo", "Increase"
content.ios_badge_countintegerNoRange: 0–99999
content.ios_interruption_levelenumNoValues: "passive", "active", "time-sensitive", "critical"
content.ios_categorystringNoLength: 0–100
content.android_channel_idstringNoLength: 0–100
content.android_groupstringNoLength: 0–100
content.android_soundstringNoLength: 0–100
content.chrome_web_iconstring (url)NoLength: 0–2000
content.chrome_web_imagestring (url)NoLength: 0–2000
content.chrome_web_badgestring (url)NoLength: 0–2000
content.web_push_topicstringNoLength: 0–32
content.content_availablebooleanNo
content.mutable_contentbooleanNo
content.custom_datamap<string, any>No
content.email_subjectstringNoLength: 0–998
content.email_bodystringNoLength: 0–500000
content.email_mjmlstringNoLength: 0–500000
content.email_preheaderstringNoLength: 0–500
content.email_from_namestringNoLength: 0–200
content.email_from_addressstring (email)NoLength: 0–320
content.email_reply_to_addressstring (email)NoLength: 0–320
content.disable_email_click_trackingbooleanNo
content.sms_fromstringNoLength: 1–20
content.disable_sms_link_shorteningbooleanNo
content.add_to_inboxbooleanNo
content.inbox_ttlintegerNoRange: 60–31536000
content.content_cardobjectNo
content.content_card.typeenumYesValues: "classic", "captioned_image", "image_only"
content.content_card.pinnedbooleanNo
content.content_card.priorityintegerNoRange: 0–100
content.content_card.button_textmap<string, string>No
content.thread_idstringNoLength: 0–100
content.ios_relevance_scorenumberNoRange: 0–1
content.target_content_identifierstringNoLength: 0–200
content.small_iconstringNoLength: 0–100
content.large_iconstring (url) | stringNo
content.android_accent_colorstringNo
content.android_visibility1 | 0 | -1No
content.web_buttonsarray<object>NoItems: 0–2
content.web_buttons[].idstringYesLength: 1–64
content.web_buttons[].textstringYesLength: 1–100
content.web_buttons[].iconstring (url)NoLength: 0–2000
content.web_buttons[].urlstring (url)NoLength: 0–2000
content.require_interactionbooleanNo
content.sms_media_urlsarray<string (url)>NoItems: 1–10
content.whatsapp_templateobjectNo
content.whatsapp_template.namestringYes
content.whatsapp_template.languagestringYes
content.whatsapp_template.headerobjectNo
content.whatsapp_template.body_paramsarray<string>NoItems: 0–20
content.whatsapp_template.button_paramsarray<object>NoItems: 0–10
content.whatsapp_template.button_params[].indexintegerYesRange: 0–9
content.whatsapp_template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
content.whatsapp_template.button_params[].valuestringYesLength: 1–256
content.whatsapp_mediaobjectNo
content.whatsapp_media.typeenumYesValues: "image", "video", "document", "audio"
content.whatsapp_media.urlstring (url)YesLength: 0–2000
content.whatsapp_media.filenamestringNoLength: 1–240
content.whatsapp_interactiveobjectNo
content.whatsapp_interactive.typeenumYesValues: "button", "list"
content.whatsapp_interactive.headerstringNoLength: 1–60
content.whatsapp_interactive.footerstringNoLength: 1–60
content.whatsapp_interactive.buttonsarray<object>NoItems: 1–3
content.whatsapp_interactive.buttons[].idstringYesLength: 1–256
content.whatsapp_interactive.buttons[].titlestringYesLength: 1–20
content.whatsapp_interactive.listobjectNo
content.whatsapp_interactive.list.buttonstringYesLength: 1–20
content.whatsapp_interactive.list.sectionsarray<object>YesItems: 1–10
content.whatsapp_interactive.list.sections[].titlestringNoLength: 1–24
content.whatsapp_interactive.list.sections[].rowsarray<object>YesItems: 1–10
content.rcs_cardobjectNo
content.rcs_card.titlemap<string, string>No
content.rcs_card.descriptionmap<string, string>No
content.rcs_card.media_urlstring (url)NoLength: 0–2000
content.rcs_card.media_heightenumNoValues: "SHORT", "MEDIUM", "TALL"
content.rcs_card.orientationenumNoValues: "VERTICAL", "HORIZONTAL"
content.rcs_suggestionsarray<object>NoItems: 0–11
content.rcs_content_sidstringNo
content.rcs_content_variablesmap<string, string>No
content.rcs_fallback_textmap<string, string>No
content.messenger_image_urlstring (url)NoLength: 0–2000
content.messenger_buttonsarray<object>NoItems: 0–6
content.ios_carouselarray<object>NoItems: 0–5
content.ios_carousel[].urlstring (url)YesLength: 0–2000
content.ios_carousel[].titlestringNoLength: 0–80
content.android_live_updateobjectNo
content.android_live_update.progressintegerYesRange: 0–100
content.android_live_update.ongoingbooleanNo
content.voipbooleanNo
content.app_clipbooleanNo
versionintegerNoRange: 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

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
languagestringYes
titlestring | nullYes
subtitlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
icon_urlstring | nullYes
buttonsarray<object>Yes
buttons[].idstringYes
buttons[].textstringYes
buttons[].urlstring | nullYes
datamap<string, string>Yes
warningsarray<string>Yes
emailobject | nullNo
smsobject | nullNo

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

On this page