PushizoDocs
API reference

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

FieldTypeRequiredDescription
namestringYesLength: 2–100
platformsarray<enum>YesItems: 1–8
frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
web_integrationenumNoValues: "code", "wordpress"
default_languagestringNoLength: 2–10
timezonestringNoLength: 1–64

Example:

{
  "name": "Sipariş bildirimleri",
  "platforms": [
    "ios"
  ],
  "framework": "native",
  "web_integration": "code",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul"
}

Responses

201 — Success.

Schema: App

FieldTypeRequiredDescription
idstringYes
org_idstringYes
namestringYes
slugstringYes
platform_flagsobjectYes
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring | nullYes
default_languagestringYes
timezonestringYes
settingsobjectYes
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
statusenumYesValues: "active", "suspended", "deleted"
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/mcp/campaign-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
namestringNoLength: 2–120
typeenumNoValues: "one_time", "scheduled", "recurring"
audienceobjectNo
audience.allbooleanNo
audience.segmentsarray<string>No
audience.exclude_segmentsarray<string>No
audience.filtersobjectNoFilter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7).
audience.filters.allarray<object>No
audience.filters.anyarray<object>No
audience.filters.nonearray<object>No
audience.channelsarray<enum>No
audience.test_devices_onlybooleanNo
contentobjectNoSame schema as messages.content (headings, contents, url, buttons…)
labelsarray<string>NoItems: 0–10
categorystring | nullNoPreference category key; users who opted out are suppressed
goalsobjectNoConversion goals (ADR-0080): the primary goal decides the A/B winner; the events must be defined as conversion events.
goals.primarystringNoLength: 0–100
goals.secondaryarray<string>NoItems: 0–2
ab_testobjectNo
ab_test.enabledbooleanNo
ab_test.test_percentageintegerNoRange: 1–100
ab_test.winnerobjectNo
ab_test.winner.modeenumNoValues: "manual", "auto"
ab_test.winner.metricenumNoValues: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerNoRange: 5–∞
variantsarray<object>NoA/B variants (weights sum to 100; at most one is_control). Items: 0–10
variants[].idstringNo
variants[].namestringYesLength: 0–60
variants[].weight_percentintegerYesRange: 1–99
variants[].contentobject | nullNo
variants[].is_controlbooleanNo
template_idstringNo
template_versionintegerNo
deliveryobjectNo
delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
delivery.delivery_time_of_daystringNo
delivery.throttle_per_minuteintegerNo
delivery.ttlintegerNo
delivery.priorityenumNoValues: 5, 10
delivery.collapse_idstringNo
delivery.frequency_cap_exemptbooleanNo
delivery.frequency_priorityenumNoValues: "low", "normal", "high"
delivery.global_control_exemptbooleanNo
delivery.quiet_hours_exemptbooleanNo
delivery.one_per_userbooleanNo
recurrenceobject | nullNo
recurrence.cronstringNo
recurrence.untilstring (date-time) | nullNo
recurrence.timezonestringNo
send_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
labelsarray<string>Yes
categorystring | nullYes
goalsobjectYes
goals.primarystringNo
goals.secondaryarray<string>No
ab_testobjectYes
ab_test.enabledbooleanNo
ab_test.test_percentageintegerNoRange: 1–100
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.metricenumYesValues: "open_rate", "click_rate", "conversion_rate"
ab_test.winner.evaluate_after_minutesintegerNoRange: 5–10080
ab_test.phaseenumNoValues: "testing", "winner_sent"
ab_test.winner_variant_idstringNo
ab_test.decided_atstringNo
ab_test.decided_bystringNo
ab_test.significanceobjectNo
ab_test.significance.p_valuenumberYes
ab_test.significance.significantbooleanYes
ab_test.significance.metricstringYes
variantsarray<object>Yes
variants[].idstringYes
variants[].namestringYes
variants[].weight_percentintegerYes
variants[].contentmap<string, any> | nullYes
variants[].is_controlbooleanYes
variants[].positionintegerYes
typeenumYesValues: "one_time", "scheduled", "recurring", "automated", "transactional"
statusenumYesValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
audiencemap<string, any>Yes
contentmap<string, any>Yes
template_idstring | nullYes
template_versioninteger | nullYes
deliveryobjectYes
delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
delivery.delivery_time_of_daystringNo
delivery.throttle_per_minuteintegerNoRange: 1–1000000
delivery.ttlintegerNoRange: 60–2419200
delivery.priority5 | 10No
delivery.collapse_idstringNoLength: 0–64
delivery.frequency_cap_exemptbooleanNo
delivery.frequency_priorityenumNoValues: "low", "normal", "high"
delivery.global_control_exemptbooleanNo
delivery.quiet_hours_exemptbooleanNo
delivery.one_per_userbooleanNo
recurrenceobject | nullYes
approvalobjectYes
approval.requiredbooleanYes
approval.pending_actionenumNoValues: "send", "schedule"
approval.requested_bystringNo
approval.requested_atstringNo
approval.approved_bystringNo
approval.approved_atstringNo
approval.rejected_bystringNo
approval.rejected_atstringNo
statsobjectYes
stats.runsintegerNo
stats.targetedintegerNo
stats.suppressedintegerNo
stats.sentintegerNo
stats.deliveredintegerNo
stats.failedintegerNo
stats.openedintegerNo
stats.clickedintegerNo
stats.convertedintegerNo
stats.bouncedintegerNo
stats.complainedintegerNo
stats.unsubscribedintegerNo
stats.sms_segmentsintegerNo
send_atstring | nullYes
next_run_atstring | nullYes
last_run_atstring | nullYes
run_countintegerYes
errorstring | nullYes
created_bystring | nullYes
started_atstring | nullYes
completed_atstring | nullYes
created_atstringYes
updated_atstringYes
estimated_recipientsinteger | nullYes
preflightobject | nullYes

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)

POST/v1/apps/{appId}/mcp/segment-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
namestringYesLength: 2–100
descriptionstring | nullNoLength: 0–500
definitionobjectYesFilter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7).
definition.allarray<object>No
definition.anyarray<object>No
definition.nonearray<object>No
is_dynamicbooleanNo

Example:

{
  "name": "Sipariş bildirimleri",
  "definition": {
    "all": [
      {}
    ],
    "any": [
      {}
    ],
    "none": [
      {}
    ]
  },
  "description": "Sipariş durumu güncellemeleri",
  "is_dynamic": true
}

Responses

200 — Success.

Schema: Segment

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
definitionmap<string, any>Yes
is_dynamicbooleanYes
estimated_countinteger | nullYes
estimated_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
sqlobject | nullYes
warehouseobject | nullYes

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)

POST/v1/apps/{appId}/mcp/template-draftsTry it (interactive API docs, new tab)

Authentication: API key — scope mcp:write (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/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)

POST/v1/apps/{appId}/mcp/journey-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
namestringYesLength: 2–120
descriptionstringNoLength: 0–500
graphobjectNoReact Flow compatible journey graph: { nodes: [{ id, type, position, data }], edges: [{ id, source, target, sourceHandle }] } (docs/journeys.md)
graph.nodesarray<object>Yes
graph.edgesarray<object>Yes
settingsobjectNoRe-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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstring | nullYes
statusenumYesValues: "draft", "active", "paused", "archived"
current_versioninteger | nullYes
draft_versioninteger | nullYes
trigger_kindstring | nullYes
published_atstring | nullYes
created_bystring | nullYes
created_atstringYes
updated_atstringYes
summaryobjectYes
summary.runs_totalintegerYes
summary.activeintegerYes
summary.completedintegerYes
summary.exitedintegerYes
summary.failedintegerYes
summary.goal_reachedintegerYes
editingobjectYes
editing.versionintegerYes
editing.graphmap<string, any>Yes
editing.settingsmap<string, any>Yes
editing.published_atstring | nullYes
editing.published_bystring | nullYes
editing.created_atstringYes
editing.updated_atstringYes
issuesarray<object>Yes
issues[].codestringYes
issues[].node_idstringNo
issues[].edge_idstringNo
issues[].messagestringYes

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)

POST/v1/apps/{appId}/mcp/in-app-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateInAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
triggersarray<object>YesItems: 1–5
trigger_groupsarray<array<object>>NoItems: 1–10
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
ab_testobjectNo
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanNo
placementstring | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/mcp/web-campaign-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWebCampaignDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
triggerobjectYes
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectNo
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
displayobjectYes
display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
display.positionenumNoValues: "left", "right"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–300
display.max_widthintegerNoRange: 280–960
display.blocksarray<object>YesItems: 0–12
display.form_idstring | nullNo
display.survey_idstring | nullNo
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen"
variants[].display.positionenumNoValues: "left", "right"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–300
variants[].display.max_widthintegerNoRange: 280–960
variants[].display.blocksarray<object>YesItems: 0–12
variants[].display.form_idstring | nullNo
variants[].display.survey_idstring | nullNo
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
triggerobjectYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
frequencyobjectYes
frequency.max_per_sessionintegerNoRange: 1–100
frequency.max_per_dayintegerNoRange: 1–100
frequency.max_totalintegerNoRange: 1–1000
frequency.hide_after_close_daysintegerNoRange: 0–365
frequency.stop_after_conversionbooleanNo
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.closesintegerYes
stats.conversionsintegerYes
stats.unique_visitorsintegerYes
stats.ctrnumberYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].ctrnumberYes
variant_stats[].conversion_ratenumberYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/mcp/web-personalization-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWebPersonalizationDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
changesarray<object>NoItems: 0–20
variantsarray<object>NoItems: 0–4
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
conditionsobjectNo
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectNo
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
goalobject | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
changesarray<object>Yes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].changesarray<object>YesItems: 0–20
ab_testobjectYes
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
conditionsobjectYes
conditions.url_rulesarray<object>NoItems: 0–10
conditions.url_rules[].openumYesValues: "equals", "contains", "starts_with", "not_contains", "matches"
conditions.url_rules[].valuestringYesLength: 1–500
conditions.utm_rulesarray<object>NoItems: 0–5
conditions.utm_rules[].paramenumYesValues: "utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"
conditions.utm_rules[].openumYesValues: "equals", "contains", "exists"
conditions.utm_rules[].valuestringNoLength: 0–200
conditions.visitsobjectNo
conditions.visits.openumYesValues: "gte", "lte", "eq"
conditions.visits.valueintegerYesRange: 1–10000
targetingobjectYes
targeting.included_segmentsarray<string>NoItems: 0–20
targeting.excluded_segmentsarray<string>NoItems: 0–20
targeting.visitorenumNoValues: "all", "new", "returning"
targeting.devicesarray<enum>NoItems: 0–3
goalobject | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.visitorsintegerYes
stats.conversionsintegerYes
stats.conversion_ratenumberYes
variant_statsarray<object>Yes
variant_stats[].visitorsintegerYes
variant_stats[].conversionsintegerYes
variant_stats[].conversion_ratenumberYes
variant_stats[].variant_idstringYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/mcp/survey-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateSurveyDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
questionsarray<object>YesItems: 1–10
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].textmap<string, string>Yes
questions[].requiredbooleanNo
questions[].optionsarray<object>NoItems: 0–30
questions[].options[].valuestringYesLength: 1–100
questions[].options[].labelmap<string, string>Yes
questions[].low_labelmap<string, string>No
questions[].high_labelmap<string, string>No
questions[].placeholdermap<string, string>No
settingsobjectNo
settings.thank_youmap<string, string>No
settings.submit_labelmap<string, string>No
settings.write_propertiesbooleanNo
settings.allow_multiplebooleanNo
settings.default_languagestringNoLength: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "closed"
questionsarray<object>YesItems: 1–10
questions[].idstringYes
questions[].typeenumYesValues: "nps", "csat", "single_choice", "multiple_choice", "text"
questions[].textmap<string, string>Yes
questions[].requiredbooleanNo
questions[].optionsarray<object>NoItems: 0–30
questions[].options[].valuestringYesLength: 1–100
questions[].options[].labelmap<string, string>Yes
questions[].low_labelmap<string, string>No
questions[].high_labelmap<string, string>No
questions[].placeholdermap<string, string>No
settingsobjectYes
settings.thank_youmap<string, string>No
settings.submit_labelmap<string, string>No
settings.write_propertiesbooleanNo
settings.allow_multiplebooleanNo
settings.default_languagestringNoLength: 2–10
in_app_message_idstring | nullYes
statsobjectYes
stats.responsesintegerYes
stats.npsnumber | nullYes
stats.last_response_atstring | nullYes
created_atstringYes
updated_atstringYes

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)

POST/v1/apps/{appId}/mcp/landing-page-draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateLandingPageDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
slugstringYesLength: 0–80
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.settings.dark_mode.background_colorstringNo
document.settings.dark_mode.content_background_colorstringNo
document.settings.dark_mode.text_colorstringNo
document.settings.dark_mode.link_colorstringNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].padding.topintegerYesRange: 0–120
document.sections[].padding.rightintegerYesRange: 0–120
document.sections[].padding.bottomintegerYesRange: 0–120
document.sections[].padding.leftintegerYesRange: 0–120
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 1–4
document.sections[].columns[].idstringYes
document.sections[].columns[].width_percentintegerNoRange: 10–100
document.sections[].columns[].background_colorstringNo
document.sections[].columns[].vertical_alignenumNoValues: "top", "middle", "bottom"
document.sections[].columns[].paddingobjectNo
document.sections[].columns[].padding.topintegerYesRange: 0–120
document.sections[].columns[].padding.rightintegerYesRange: 0–120
document.sections[].columns[].padding.bottomintegerYesRange: 0–120
document.sections[].columns[].padding.leftintegerYesRange: 0–120
document.sections[].columns[].blocksarray<object>YesItems: 0–30
seoobjectNo
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectNo
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
slugstringYes
statusenumYesValues: "draft", "published", "archived"
seoobjectYes
seo.titlestringNoLength: 0–120
seo.descriptionstringNoLength: 0–320
seo.og_imagestring (url)NoLength: 0–2000
seo.canonical_urlstring (url)NoLength: 0–2000
seo.noindexbooleanNo
settingsobjectYes
settings.languagestringNoLength: 2–10
settings.form_idstring | nullNo
settings.form_section_idstring | nullNo
settings.cookie_consentobjectNo
settings.cookie_consent.enabledbooleanYes
settings.cookie_consent.textstringNoLength: 0–1000
settings.cookie_consent.accept_labelstringNoLength: 0–60
settings.cookie_consent.reject_labelstringNoLength: 0–60
settings.cookie_consent.policy_urlstring (url)NoLength: 0–2000
settings.web_sdkbooleanNo
settings.favicon_urlstring (url)NoLength: 0–2000
custom_domain_idstring | nullYes
versionintegerYes
published_versioninteger | nullYes
published_atstring | nullYes
has_unpublished_changesbooleanYes
urlstringYes
domain_urlstring | nullYes
statsobjectYes
stats.submissionsintegerYes
created_atstringYes
updated_atstringYes
documentobjectYes
document.version1Yes
document.settingsobjectYes
document.settings.widthintegerNoRange: 480–800
document.settings.background_colorstringNo
document.settings.content_background_colorstringNo
document.settings.text_colorstringNo
document.settings.link_colorstringNo
document.settings.font_familyenumNoValues: "system", "arial", "georgia", "verdana", "trebuchet", "courier"
document.settings.dark_modeobjectNo
document.sectionsarray<object>YesItems: 0–50
document.sections[].idstringYes
document.sections[].type"section"Yes
document.sections[].background_colorstringNo
document.sections[].background_imagestringNoLength: 1–2000
document.sections[].paddingobjectNo
document.sections[].stack_on_mobilebooleanNo
document.sections[].columnsarray<object>YesItems: 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)

POST/v1/apps/{appId}/mcp/test-sendsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: TestPushDto

FieldTypeRequiredDescription
subscription_idsarray<string>NoItems: 1–2000
headingsmap<string, string>No
contentsmap<string, string>Yes
urlstring (url)NoLength: 0–2000
datamap<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

FieldTypeRequiredDescription
idstringYes
statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
recipients_estimateintegerYes
external_id_missingarray<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"
  ]
}'

On this page