MCP drafts
MCP drafts — 11 operations (POST /v1/mcp/apps, POST /v1/apps/{appId}/mcp/campaign-drafts, POST /v1/apps/{appId}/mcp/segment-drafts, …). Generated from the OpenAPI 3.1.0 contract.
Drafts created by the MCP server's write tools: campaigns, segments, templates, journeys, in-app messages, web campaigns, web personalization, surveys and landing pages (mcp:write scope); they neither send nor publish.
Base URL: https://api.pushizo.com · Tag: mcp · Interactive docs (Scalar)
Operations
Details
App oluştur ve kurulum kaydını yaz (MCP onaylı mod; org geneli anahtar + app oluşturma yetkisi)
Authentication: API key — scope mcp:write (admin includes every scope).
Request body (required)
Schema: CreateSetupAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
platforms | array<enum> | Yes | Items: 1–8 |
framework | enum | No | Values: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui" |
web_integration | enum | No | Values: "code", "wordpress" |
default_language | string | No | Length: 2–10 |
timezone | string | No | Length: 1–64 |
Example:
{
"name": "Sipariş bildirimleri",
"platforms": [
"ios"
],
"framework": "native",
"web_integration": "code",
"default_language": "örnek",
"timezone": "Europe/Istanbul"
}Responses
201 — Success.
Schema: App
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
org_id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
platform_flags | object | Yes | |
platform_flags.ios | boolean | No | |
platform_flags.android | boolean | No | |
platform_flags.web | boolean | No | |
platform_flags.email | boolean | No | |
platform_flags.sms | boolean | No | |
icon_url | string | null | Yes | |
default_language | string | Yes | |
timezone | string | Yes | |
settings | object | Yes | |
settings.quietHours | object | null | No | |
settings.frequencyCap | object | null | No | |
settings.frequencyCaps | array<object> | No | Items: 0–10 |
settings.frequencyCaps[].max | integer | Yes | Range: 1–1000 |
settings.frequencyCaps[].window | object | Yes | |
settings.frequencyCaps[].channels | array<enum> | No | Items: 1–12 |
settings.inApp | object | No | |
settings.inApp.minIntervalSeconds | integer | No | Range: 0–604800 |
settings.androidChannels | array<object> | No | Items: 0–50 |
settings.androidChannels[].id | string | Yes | Length: 1–64 |
settings.androidChannels[].name | string | Yes | Length: 1–60 |
settings.androidChannels[].description | string | No | Length: 0–200 |
settings.androidChannels[].importance | enum | Yes | Values: "low", "default", "high", "urgent" |
settings.androidChannels[].sound | string | No | Length: 0–64 |
settings.androidChannels[].vibration | boolean | No | |
settings.androidChannels[].group | string | No | Length: 0–64 |
settings.sms | object | No | |
settings.sms.helpReply | string | No | Length: 0–320 |
settings.sms.stopReply | string | No | Length: 0–320 |
settings.sms.autoReply | boolean | No | |
settings.preferenceCenter | object | No | |
settings.preferenceCenter.enabled | boolean | No | |
settings.preferenceCenter.brandName | string | No | Length: 0–80 |
settings.preferenceCenter.logoUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.accentColor | string | No | |
settings.preferenceCenter.customUnsubscribeUrl | string (url) | No | Length: 0–2000 |
settings.preferenceCenter.texts | map<string, object> | No | |
settings.brandKit | object | No | |
settings.brandKit.website_url | string (url) | No | Length: 0–2000 |
settings.brandKit.name | string | No | Length: 0–80 |
settings.brandKit.primary_color | string | No | |
settings.brandKit.accent_color | string | No | |
settings.brandKit.font | string | No | Length: 0–40 |
settings.brandKit.logo_url | string (url) | No | Length: 0–2000 |
settings.brandKit.tone | string | No | Length: 0–240 |
settings.defaultTtlSeconds | integer | No | Range: 60–2419200 |
settings.identityVerificationRequired | boolean | No | |
settings.ipCapture | enum | No | Values: "off", "full", "masked" |
settings.ipRetentionDays | integer | No | Range: 1–365 |
settings.adaptiveFrequency | object | No | |
settings.adaptiveFrequency.enabled | boolean | Yes | |
settings.adaptiveFrequency.min | integer | Yes | Range: 1–50 |
settings.adaptiveFrequency.max | integer | Yes | Range: 1–50 |
settings.allowedOrigins | array<string> | No | Items: 0–50 |
settings.campaignApprovalRequired | boolean | No | |
settings.webPush | object | No | |
settings.webPush.serviceWorkerPath | string | No | Length: 0–200 |
settings.webPush.serviceWorkerScope | string | No | Length: 0–200 |
settings.webPush.prompt | object | No | |
settings.webPush.welcomeNotification | object | No | |
settings.webPush.clickBehavior | object | No | |
settings.webPush.customLink | object | No | |
settings.webPush.promptBackoffDays | array<integer> | No | Items: 0–10 |
settings.onboarding | object | No | |
settings.onboarding.step | integer | Yes | Range: 0–6 |
settings.onboarding.simulation | boolean | No | |
settings.onboarding.completed_at | string | null | No | |
settings.onboarding.version | integer | No | Range: 1–100 |
settings.onboarding.platforms | array<enum> | No | Items: 0–8 |
settings.onboarding.framework | enum | No | Values: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui" |
settings.onboarding.web_integration | enum | No | Values: "code", "wordpress" |
settings.sdkSetup | object | null | No | |
identity_verification_mode | enum | Yes | Values: "hmac", "jwt", "both" |
status | enum | Yes | Values: "active", "suspended", "deleted" |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "active",
"id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"platform_flags": {
"ios": true,
"android": true,
"web": true,
"email": true
},
"icon_url": "https://pushizo.com/orders/1001",
"default_language": "örnek",
"timezone": "Europe/Istanbul",
"settings": {
"quietHours": {
"start": "2026-10-01T00:00:00Z",
"end": "2026-10-17T00:00:00Z",
"timezoneMode": "user"
},
"frequencyCap": {
"max": 1,
"windowHours": 1
},
"frequencyCaps": [
{
"max": 1,
"window": {
"value": 150,
"unit": "minutes"
},
"channels": [
"ios_push"
]
}
],
"inApp": {
"minIntervalSeconds": 1
}
},
"identity_verification_mode": "hmac",
"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/mcp/apps" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"platforms": [
"ios"
],
"framework": "native",
"web_integration": "code",
"default_language": "örnek",
"timezone": "Europe/Istanbul"
}'Create a campaign draft (MCP approval mode; does not send)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–120 |
type | enum | No | Values: "one_time", "scheduled", "recurring" |
audience | object | No | |
audience.all | boolean | No | |
audience.segments | array<string> | No | |
audience.exclude_segments | array<string> | No | |
audience.filters | object | No | Filter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7). |
audience.filters.all | array<object> | No | |
audience.filters.any | array<object> | No | |
audience.filters.none | array<object> | No | |
audience.channels | array<enum> | No | |
audience.test_devices_only | boolean | No | |
content | object | No | Same schema as messages.content (headings, contents, url, buttons…) |
labels | array<string> | No | Items: 0–10 |
category | string | null | No | Preference category key; users who opted out are suppressed |
goals | object | No | Conversion goals (ADR-0080): the primary goal decides the A/B winner; the events must be defined as conversion events. |
goals.primary | string | No | Length: 0–100 |
goals.secondary | array<string> | No | Items: 0–2 |
ab_test | object | No | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | No | Values: "manual", "auto" |
ab_test.winner.metric | enum | No | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–∞ |
variants | array<object> | No | A/B variants (weights sum to 100; at most one is_control). Items: 0–10 |
variants[].id | string | No | |
variants[].name | string | Yes | Length: 0–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].content | object | null | No | |
variants[].is_control | boolean | No | |
template_id | string | No | |
template_version | integer | No | |
delivery | object | No | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | |
delivery.ttl | integer | No | |
delivery.priority | enum | No | Values: 5, 10 |
delivery.collapse_id | string | No | |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | No | |
recurrence.cron | string | No | |
recurrence.until | string (date-time) | null | No | |
recurrence.timezone | string | No | |
send_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"audience": {
"channels": [
"ios_push"
],
"all": false,
"segments": [
"örnek"
]
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"labels": [
"promo"
]
}Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_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/mcp/campaign-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"type": "one_time",
"audience": {
"channels": [
"ios_push"
],
"all": false,
"segments": [
"örnek"
]
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"labels": [
"promo"
]
}'Create a segment draft (MCP approval mode; dynamic segment)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
description | string | null | No | Length: 0–500 |
definition | object | Yes | Filter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7). |
definition.all | array<object> | No | |
definition.any | array<object> | No | |
definition.none | array<object> | No | |
is_dynamic | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"definition": {
"all": [
{}
],
"any": [
{}
],
"none": [
{}
]
},
"description": "Sipariş durumu güncellemeleri",
"is_dynamic": true
}Responses
200 — Success.
Schema: Segment
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
definition | map<string, any> | Yes | |
is_dynamic | boolean | Yes | |
estimated_count | integer | null | Yes | |
estimated_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
sql | object | null | Yes | |
warehouse | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "seg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"definition": {
"key": "örnek"
},
"is_dynamic": true,
"estimated_count": 1,
"estimated_at": "örnek",
"created_by": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"sql": {
"query": "ayse",
"refresh_interval_minutes": 1,
"refreshed_at": "örnek",
"member_count": 1,
"last_error": "örnek"
},
"warehouse": {
"connection_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"query": "ayse",
"id_column": "örnek",
"id_type": "external_id",
"limits": {
"timeout_seconds": 1,
"max_rows": 1,
"max_bytes_billed": 1.5,
"max_warehouse_size": "X-Small"
},
"refresh_interval_minutes": 1,
"refresh_state": "queued",
"refresh_requested_at": "örnek",
"refreshed_at": "örnek",
"member_count": 1,
"last_error": "örnek",
"bytes_processed": 1.5
}
}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/mcp/segment-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"definition": {
"all": [
{}
],
"any": [
{}
],
"none": [
{}
]
},
"description": "Sipariş durumu güncellemeleri",
"is_dynamic": true
}'Create a template (MCP approval mode; a template does not send on its own)
Authentication: API key — scope mcp:write (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/mcp/template-drafts" \
-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"
]
}'Create a journey draft (MCP approval mode; not published)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–120 |
description | string | No | Length: 0–500 |
graph | object | No | React Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md) |
graph.nodes | array<object> | Yes | |
graph.edges | array<object> | Yes | |
settings | object | No | Re-entry, new entrants only, exit rules, exit tags, goals, schedule (docs/journeys.md) |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"graph": {
"nodes": [
{}
],
"edges": [
{}
]
},
"settings": {}
}Responses
200 — Success.
Schema: JourneyDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
current_version | integer | null | Yes | |
draft_version | integer | null | Yes | |
trigger_kind | string | null | Yes | |
published_at | string | null | Yes | |
created_by | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
summary | object | Yes | |
summary.runs_total | integer | Yes | |
summary.active | integer | Yes | |
summary.completed | integer | Yes | |
summary.exited | integer | Yes | |
summary.failed | integer | Yes | |
summary.goal_reached | integer | Yes | |
editing | object | Yes | |
editing.version | integer | Yes | |
editing.graph | map<string, any> | Yes | |
editing.settings | map<string, any> | Yes | |
editing.published_at | string | null | Yes | |
editing.published_by | string | null | Yes | |
editing.created_at | string | Yes | |
editing.updated_at | string | Yes | |
issues | array<object> | Yes | |
issues[].code | string | Yes | |
issues[].node_id | string | No | |
issues[].edge_id | string | No | |
issues[].message | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "jrn_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"current_version": 1,
"draft_version": 1,
"trigger_kind": "örnek",
"published_at": "örnek",
"created_by": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"summary": {
"runs_total": 1,
"active": 1,
"completed": 1,
"exited": 1,
"failed": 1,
"goal_reached": 1
},
"editing": {
"version": 1,
"graph": {
"key": "örnek"
},
"settings": {},
"published_at": "örnek",
"published_by": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
},
"issues": [
{
"code": "örnek",
"message": "Takip bağlantısı içeride",
"node_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"edge_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
]
}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/mcp/journey-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"graph": {
"nodes": [
{}
],
"edges": [
{}
]
},
"settings": {}
}'Create an in-app message draft (MCP approval mode; not activated)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
triggers | array<object> | Yes | Items: 1–5 |
trigger_groups | array<array<object>> | No | Items: 1–10 |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
ab_test | object | No | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | No | |
placement | string | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
}
}Responses
200 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"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/mcp/in-app-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
}
}'Create a web campaign draft (MCP approval mode; not published)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateWebCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
trigger | object | Yes | |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
frequency | object | No | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1
},
"priority": 10
}Responses
200 — Success.
Schema: WebCampaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
display | object | Yes | |
display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
display.position | enum | No | Values: "left", "right" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–300 |
display.max_width | integer | No | Range: 280–960 |
display.blocks | array<object> | Yes | Items: 0–12 |
display.form_id | string | null | No | |
display.survey_id | string | null | No | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
variants[].display.position | enum | No | Values: "left", "right" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–300 |
variants[].display.max_width | integer | No | Range: 280–960 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
variants[].display.form_id | string | null | No | |
variants[].display.survey_id | string | null | No | |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
trigger | object | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
frequency | object | Yes | |
frequency.max_per_session | integer | No | Range: 1–100 |
frequency.max_per_day | integer | No | Range: 1–100 |
frequency.max_total | integer | No | Range: 1–1000 |
frequency.hide_after_close_days | integer | No | Range: 0–365 |
frequency.stop_after_conversion | boolean | No | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.closes | integer | Yes | |
stats.conversions | integer | Yes | |
stats.unique_visitors | integer | Yes | |
stats.ctr | number | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].ctr | number | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left",
"background_color": "değer"
}
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1,
"hide_after_close_days": 1
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"closes": 1,
"conversions": 1,
"unique_visitors": 1,
"ctr": 1.5,
"conversion_rate": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"conversions": 1,
"ctr": 1.5,
"conversion_rate": 1.5
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"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/mcp/web-campaign-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"display": {
"layout": "popup",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"position": "left",
"background_color": "değer",
"text_color": "değer"
},
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "popup",
"blocks": [
{}
],
"position": "left"
}
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1,
"max_total": 1
},
"priority": 10
}'Create a web personalization draft (MCP approval mode; not published)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateWebPersonalizationDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
changes | array<object> | No | Items: 0–20 |
variants | array<object> | No | Items: 0–4 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
conditions | object | No | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | No | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"goal": {
"type": "event",
"event": "purchase"
}
}Responses
200 — Success.
Schema: WebPersonalization
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
changes | array<object> | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].changes | array<object> | Yes | Items: 0–20 |
ab_test | object | Yes | |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
conditions | object | Yes | |
conditions.url_rules | array<object> | No | Items: 0–10 |
conditions.url_rules[].op | enum | Yes | Values: "equals", "contains", "starts_with", "not_contains", "matches" |
conditions.url_rules[].value | string | Yes | Length: 1–500 |
conditions.utm_rules | array<object> | No | Items: 0–5 |
conditions.utm_rules[].param | enum | Yes | Values: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content" |
conditions.utm_rules[].op | enum | Yes | Values: "equals", "contains", "exists" |
conditions.utm_rules[].value | string | No | Length: 0–200 |
conditions.visits | object | No | |
conditions.visits.op | enum | Yes | Values: "gte", "lte", "eq" |
conditions.visits.value | integer | Yes | Range: 1–10000 |
targeting | object | Yes | |
targeting.included_segments | array<string> | No | Items: 0–20 |
targeting.excluded_segments | array<string> | No | Items: 0–20 |
targeting.visitor | enum | No | Values: "all", "new", "returning" |
targeting.devices | array<enum> | No | Items: 0–3 |
goal | object | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.visitors | integer | Yes | |
stats.conversions | integer | Yes | |
stats.conversion_rate | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].visitors | integer | Yes | |
variant_stats[].conversions | integer | Yes | |
variant_stats[].conversion_rate | number | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek"
},
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all",
"devices": [
"desktop"
]
},
"goal": {
"type": "event",
"event": "purchase"
},
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5
},
"variant_stats": [
{
"visitors": 1,
"conversions": 1,
"conversion_rate": 1.5,
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}
],
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"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/mcp/web-personalization-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"changes": [
{
"action": "text",
"selector": "değer",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": [
{
"action": "text",
"selector": "değer",
"text": {}
}
]
}
],
"conditions": {
"url_rules": [
{
"op": "equals",
"value": "user_42"
}
],
"utm_rules": [
{
"param": "utm_source",
"op": "equals",
"value": "user_42"
}
],
"visits": {
"op": "gte",
"value": 150
}
},
"targeting": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"visitor": "all"
},
"goal": {
"type": "event",
"event": "purchase"
}
}'Create a survey draft (MCP approval mode; not activated)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateSurveyDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
questions | array<object> | Yes | Items: 1–10 |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].text | map<string, string> | Yes | |
questions[].required | boolean | No | |
questions[].options | array<object> | No | Items: 0–30 |
questions[].options[].value | string | Yes | Length: 1–100 |
questions[].options[].label | map<string, string> | Yes | |
questions[].low_label | map<string, string> | No | |
questions[].high_label | map<string, string> | No | |
questions[].placeholder | map<string, string> | No | |
settings | object | No | |
settings.thank_you | map<string, string> | No | |
settings.submit_label | map<string, string> | No | |
settings.write_properties | boolean | No | |
settings.allow_multiple | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
Example:
{
"name": "Sipariş bildirimleri",
"questions": [
{
"type": "nps",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"required": true,
"options": [
{
"value": "user_42",
"label": {}
}
],
"low_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"settings": {
"thank_you": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"submit_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"write_properties": true
}
}Responses
200 — Success.
Schema: Survey
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "closed" |
questions | array<object> | Yes | Items: 1–10 |
questions[].id | string | Yes | |
questions[].type | enum | Yes | Values: "nps", "csat", "single_choice", "multiple_choice", "text" |
questions[].text | map<string, string> | Yes | |
questions[].required | boolean | No | |
questions[].options | array<object> | No | Items: 0–30 |
questions[].options[].value | string | Yes | Length: 1–100 |
questions[].options[].label | map<string, string> | Yes | |
questions[].low_label | map<string, string> | No | |
questions[].high_label | map<string, string> | No | |
questions[].placeholder | map<string, string> | No | |
settings | object | Yes | |
settings.thank_you | map<string, string> | No | |
settings.submit_label | map<string, string> | No | |
settings.write_properties | boolean | No | |
settings.allow_multiple | boolean | No | |
settings.default_language | string | No | Length: 2–10 |
in_app_message_id | string | null | Yes | |
stats | object | Yes | |
stats.responses | integer | Yes | |
stats.nps | number | null | Yes | |
stats.last_response_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "srv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"questions": [
{
"type": "nps",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"required": true,
"options": [
{
"value": "user_42",
"label": {}
}
],
"low_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"high_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"settings": {
"thank_you": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"submit_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"write_properties": true,
"allow_multiple": false
},
"in_app_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"stats": {
"responses": 1,
"nps": 1.5,
"last_response_at": "ö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/mcp/survey-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"questions": [
{
"type": "nps",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"required": true,
"options": [
{
"value": "user_42",
"label": {}
}
],
"low_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"settings": {
"thank_you": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"submit_label": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"write_properties": true
}
}'Create a landing page draft (MCP approval mode; not published)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateLandingPageDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
slug | string | Yes | Length: 0–80 |
document | object | Yes | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.settings.dark_mode.background_color | string | No | |
document.settings.dark_mode.content_background_color | string | No | |
document.settings.dark_mode.text_color | string | No | |
document.settings.dark_mode.link_color | string | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].padding.top | integer | Yes | Range: 0–120 |
document.sections[].padding.right | integer | Yes | Range: 0–120 |
document.sections[].padding.bottom | integer | Yes | Range: 0–120 |
document.sections[].padding.left | integer | Yes | Range: 0–120 |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
document.sections[].columns[].id | string | Yes | |
document.sections[].columns[].width_percent | integer | No | Range: 10–100 |
document.sections[].columns[].background_color | string | No | |
document.sections[].columns[].vertical_align | enum | No | Values: "top", "middle", "bottom" |
document.sections[].columns[].padding | object | No | |
document.sections[].columns[].padding.top | integer | Yes | Range: 0–120 |
document.sections[].columns[].padding.right | integer | Yes | Range: 0–120 |
document.sections[].columns[].padding.bottom | integer | Yes | Range: 0–120 |
document.sections[].columns[].padding.left | integer | Yes | Range: 0–120 |
document.sections[].columns[].blocks | array<object> | Yes | Items: 0–30 |
seo | object | No | |
seo.title | string | No | Length: 0–120 |
seo.description | string | No | Length: 0–320 |
seo.og_image | string (url) | No | Length: 0–2000 |
seo.canonical_url | string (url) | No | Length: 0–2000 |
seo.noindex | boolean | No | |
settings | object | No | |
settings.language | string | No | Length: 2–10 |
settings.form_id | string | null | No | |
settings.form_section_id | string | null | No | |
settings.cookie_consent | object | No | |
settings.cookie_consent.enabled | boolean | Yes | |
settings.cookie_consent.text | string | No | Length: 0–1000 |
settings.cookie_consent.accept_label | string | No | Length: 0–60 |
settings.cookie_consent.reject_label | string | No | Length: 0–60 |
settings.cookie_consent.policy_url | string (url) | No | Length: 0–2000 |
settings.web_sdk | boolean | No | |
settings.favicon_url | string (url) | No | Length: 0–2000 |
custom_domain_id | string | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"document": {
"version": 1,
"settings": {
"width": 480
},
"sections": [
{
"type": "section",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"columns": [
{}
],
"background_color": "değer"
}
]
},
"seo": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"og_image": "https://pushizo.com/orders/1001"
},
"settings": {
"language": "tr",
"form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"form_section_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: LandingPage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
slug | string | Yes | |
status | enum | Yes | Values: "draft", "published", "archived" |
seo | object | Yes | |
seo.title | string | No | Length: 0–120 |
seo.description | string | No | Length: 0–320 |
seo.og_image | string (url) | No | Length: 0–2000 |
seo.canonical_url | string (url) | No | Length: 0–2000 |
seo.noindex | boolean | No | |
settings | object | Yes | |
settings.language | string | No | Length: 2–10 |
settings.form_id | string | null | No | |
settings.form_section_id | string | null | No | |
settings.cookie_consent | object | No | |
settings.cookie_consent.enabled | boolean | Yes | |
settings.cookie_consent.text | string | No | Length: 0–1000 |
settings.cookie_consent.accept_label | string | No | Length: 0–60 |
settings.cookie_consent.reject_label | string | No | Length: 0–60 |
settings.cookie_consent.policy_url | string (url) | No | Length: 0–2000 |
settings.web_sdk | boolean | No | |
settings.favicon_url | string (url) | No | Length: 0–2000 |
custom_domain_id | string | null | Yes | |
version | integer | Yes | |
published_version | integer | null | Yes | |
published_at | string | null | Yes | |
has_unpublished_changes | boolean | Yes | |
url | string | Yes | |
domain_url | string | null | Yes | |
stats | object | Yes | |
stats.submissions | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
document | object | Yes | |
document.version | 1 | Yes | |
document.settings | object | Yes | |
document.settings.width | integer | No | Range: 480–800 |
document.settings.background_color | string | No | |
document.settings.content_background_color | string | No | |
document.settings.text_color | string | No | |
document.settings.link_color | string | No | |
document.settings.font_family | enum | No | Values: "system", "arial", "georgia", "verdana", "trebuchet", "courier" |
document.settings.dark_mode | object | No | |
document.sections | array<object> | Yes | Items: 0–50 |
document.sections[].id | string | Yes | |
document.sections[].type | "section" | Yes | |
document.sections[].background_color | string | No | |
document.sections[].background_image | string | No | Length: 1–2000 |
document.sections[].padding | object | No | |
document.sections[].stack_on_mobile | boolean | No | |
document.sections[].columns | array<object> | Yes | Items: 1–4 |
Example response:
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"status": "draft",
"id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"slug": "magaza",
"seo": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"og_image": "https://pushizo.com/orders/1001",
"canonical_url": "https://pushizo.com/orders/1001"
},
"settings": {
"language": "tr",
"form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"form_section_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"cookie_consent": {
"enabled": true,
"text": "Takip bağlantısı içeride",
"accept_label": "örnek"
}
},
"custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"version": 1,
"published_version": 1,
"published_at": "örnek",
"has_unpublished_changes": true,
"domain_url": "https://pushizo.com/orders/1001",
"stats": {
"submissions": 1
},
"created_at": "örnek",
"updated_at": "örnek",
"document": {
"version": 1,
"settings": {
"width": 480,
"background_color": "değer"
},
"sections": [
{
"type": "section",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"columns": [
{}
],
"background_color": "değer",
"background_image": "ö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/mcp/landing-page-drafts" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"slug": "magaza",
"document": {
"version": 1,
"settings": {
"width": 480
},
"sections": [
{
"type": "section",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"columns": [
{}
],
"background_color": "değer"
}
]
},
"seo": {
"title": "Siparişiniz yola çıktı",
"description": "Sipariş durumu güncellemeleri",
"og_image": "https://pushizo.com/orders/1001"
},
"settings": {
"language": "tr",
"form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"form_section_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"custom_domain_id": "lpg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Test send (only to the app’s test devices; MCP approval mode)
Authentication: API key — scope mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: TestPushDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_ids | array<string> | No | Items: 1–2000 |
headings | map<string, string> | No | |
contents | map<string, string> | Yes | |
url | string (url) | No | Length: 0–2000 |
data | map<string, string> | No |
Example:
{
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"subscription_ids": [
"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}Responses
202 — Success.
Schema: CreateNotificationResult
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
recipients_estimate | integer | Yes | |
external_id_missing | array<string> | Yes |
Example response:
{
"status": "queued",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"recipients_estimate": 1,
"external_id_missing": [
"ö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/mcp/test-sends" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"contents": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"headings": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
},
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"subscription_ids": [
"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}'Landing pages
Landing pages — 10 operations (GET /v1/apps/{appId}/landing-pages, POST /v1/apps/{appId}/landing-pages, GET /v1/apps/{appId}/landing-pages/{pageId}, …). Generated from the OpenAPI 3.1.0 contract.
SDK endpoints (client)
SDK endpoints (client) — 51 operations (GET /sdk/v1/apps/{appId}/config, POST /sdk/v1/apps/{appId}/subscriptions, PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, …). Generated from the OpenAPI 3.1.0 contract.