PushizoDocs
API reference

Campaigns

Campaigns — 28 operations (GET /v1/apps/{appId}/custom-agents, POST /v1/apps/{appId}/custom-agents, GET /v1/apps/{appId}/custom-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.

Campaign lifecycle: create, schedule, send, pause/resume, cancel, approve, A/B variant statistics and winner selection.

Base URL: https://api.pushizo.com · Tag: campaigns · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/custom-agentsCustom AI agents
POST/v1/apps/{appId}/custom-agentsCreate custom AI agent
GET/v1/apps/{appId}/custom-agents/runsCustom AI agent runs
GET/v1/apps/{appId}/custom-agents/draftsCustom AI agent drafts
GET/v1/apps/{appId}/custom-agents/{agentId}Custom AI agent
PATCH/v1/apps/{appId}/custom-agents/{agentId}Update custom AI agent
DELETE/v1/apps/{appId}/custom-agents/{agentId}Delete custom AI agent
POST/v1/apps/{appId}/custom-agents/{agentId}/runRun custom AI agent now
GET/v1/apps/{appId}/campaignsList campaigns
POST/v1/apps/{appId}/campaignsCreate a campaign
GET/v1/apps/{appId}/campaigns/{campaignId}Campaign details
PATCH/v1/apps/{appId}/campaigns/{campaignId}Update a campaign
DELETE/v1/apps/{appId}/campaigns/{campaignId}Delete a campaign
POST/v1/apps/{appId}/campaigns/{campaignId}/scheduleSchedule; email list protection 409 → force=true (admin scope)
POST/v1/apps/{appId}/campaigns/{campaignId}/sendSend now; email list protection 409 → force=true (admin scope)
POST/v1/apps/{appId}/campaigns/{campaignId}/preflightPre-send check report (brand, banned phrases, links, personalization, KVKK/IYS)
GET/v1/apps/{appId}/campaigns/{campaignId}/email-riskEmail list risk (estimated invalid rate, 7/30-day bounce rate)
POST/v1/apps/{appId}/campaigns/{campaignId}/pausePause
POST/v1/apps/{appId}/campaigns/{campaignId}/resumeResume
POST/v1/apps/{appId}/campaigns/{campaignId}/cancelCancel
POST/v1/apps/{appId}/campaigns/{campaignId}/duplicateDuplicate
POST/v1/apps/{appId}/campaigns/{campaignId}/approveApprove
GET/v1/apps/{appId}/campaigns/{campaignId}/statsStatistics
GET/v1/apps/{appId}/campaigns/{campaignId}/variants/statsA/B variant comparison
POST/v1/apps/{appId}/campaigns/{campaignId}/winnerPick the A/B winner
GET/v1/apps/{appId}/campaigns/{campaignId}/deliveriesPer-subscriber deliveries
POST/v1/apps/{appId}/campaigns/{campaignId}/resend-failedResend to failed deliveries
GET/v1/apps/{appId}/campaigns/{campaignId}/messagesCampaign runs

Details

Custom AI agents

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CustomAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].descriptionstringYes
data[].enabledbooleanYes
data[].instructionsstringYes
data[].toolsarray<enum>Yes
data[].scheduleobject | nullYes
data[].limitsobjectYes
data[].limits.max_stepsintegerYes
data[].limits.monthly_token_capintegerYes
data[].next_run_atstring | nullYes
data[].last_run_atstring | nullYes
data[].usageobjectYes
data[].usage.tokens_this_monthintegerYes
data[].usage.period_startstringYes
data[].created_atstringYes
data[].updated_atstringYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "enabled": true,
      "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "instructions": "örnek",
      "tools": [
        "list_segments"
      ],
      "schedule": {
        "cron": "örnek",
        "timezone": "Europe/Istanbul"
      },
      "limits": {
        "max_steps": 1,
        "monthly_token_cap": 1
      },
      "next_run_at": "örnek",
      "last_run_at": "örnek",
      "usage": {
        "tokens_this_month": 1,
        "period_start": "örnek"
      },
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create custom AI agent

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateCustomAgentDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstringNoLength: 0–300
enabledbooleanNo
instructionsstringNoLength: 0–4000
toolsarray<enum>NoItems: 0–5
scheduleobject | nullNo
limitsobjectNo
limits.max_stepsintegerNoRange: 1–10
limits.monthly_token_capintegerNoRange: 1000–20000000

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ],
  "schedule": {
    "cron": "xxxxxxxxx",
    "timezone": "Europe/Istanbul"
  }
}

Responses

201 — Success.

Schema: CustomAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
instructionsstringYes
toolsarray<enum>Yes
scheduleobject | nullYes
limitsobjectYes
limits.max_stepsintegerYes
limits.monthly_token_capintegerYes
next_run_atstring | nullYes
last_run_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ],
  "schedule": {
    "cron": "örnek",
    "timezone": "Europe/Istanbul"
  },
  "limits": {
    "max_steps": 1,
    "monthly_token_cap": 1
  },
  "next_run_at": "örnek",
  "last_run_at": "örnek",
  "usage": {
    "tokens_this_month": 1,
    "period_start": "ö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/custom-agents" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ],
  "schedule": {
    "cron": "xxxxxxxxx",
    "timezone": "Europe/Istanbul"
  }
}'

Custom AI agent runs

GET/v1/apps/{appId}/custom-agents/runsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agent_idquerystringNo"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "running", "succeeded", "failed", "skipped""pending"
limitqueryintegerNoRange: 1–10050
cursorquerystringNo"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CustomAgentRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].triggerenumYesValues: "schedule", "manual"
data[].statusenumYesValues: "pending", "running", "succeeded", "failed", "skipped"
data[].stepsarray<object>Yes
data[].steps[].kindenumYesValues: "tool", "finish"
data[].steps[].toolstringNo
data[].steps[].okbooleanNo
data[].steps[].errorstringNo
data[].steps[].duration_msintegerNo
data[].summarystring | nullYes
data[].input_tokensintegerYes
data[].output_tokensintegerYes
data[].errorstring | nullYes
data[].draftsintegerYes
data[].created_atstringYes
data[].started_atstring | nullYes
data[].finished_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": "pending",
      "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "agent_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "trigger": "schedule",
      "steps": [
        {
          "kind": "tool",
          "tool": "örnek",
          "ok": true
        }
      ],
      "summary": "örnek",
      "input_tokens": 1,
      "output_tokens": 1,
      "error": "örnek",
      "drafts": 1,
      "created_at": "örnek",
      "started_at": "örnek",
      "finished_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents/runs?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Custom AI agent drafts

GET/v1/apps/{appId}/custom-agents/draftsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agent_idquerystringNo"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
run_idquerystringNo"run_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "applied", "dismissed""pending"
limitqueryintegerNoRange: 1–10050
cursorquerystringNo"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CustomAgentDraftList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].run_idstringYes
data[].kindenumYesValues: "segment", "campaign"
data[].statusenumYesValues: "pending", "applied", "dismissed"
data[].payloadmap<string, any>Yes
data[].result_idstring | nullYes
data[].decided_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": "pending",
      "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "agent_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "run_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "kind": "segment",
      "payload": {
        "key": "örnek"
      },
      "result_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "decided_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents/drafts?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Custom AI agent

GET/v1/apps/{appId}/custom-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CustomAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
instructionsstringYes
toolsarray<enum>Yes
scheduleobject | nullYes
limitsobjectYes
limits.max_stepsintegerYes
limits.monthly_token_capintegerYes
next_run_atstring | nullYes
last_run_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ],
  "schedule": {
    "cron": "örnek",
    "timezone": "Europe/Istanbul"
  },
  "limits": {
    "max_steps": 1,
    "monthly_token_cap": 1
  },
  "next_run_at": "örnek",
  "last_run_at": "örnek",
  "usage": {
    "tokens_this_month": 1,
    "period_start": "örnek"
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update custom AI agent

PATCH/v1/apps/{appId}/custom-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateCustomAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstringNoLength: 0–300
enabledbooleanNo
instructionsstringNoLength: 0–4000
toolsarray<enum>NoItems: 0–5
scheduleobject | nullNo
limitsobjectNo
limits.max_stepsintegerNoRange: 1–10
limits.monthly_token_capintegerNoRange: 1000–20000000

Example:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ]
}

Responses

200 — Success.

Schema: CustomAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
descriptionstringYes
enabledbooleanYes
instructionsstringYes
toolsarray<enum>Yes
scheduleobject | nullYes
limitsobjectYes
limits.max_stepsintegerYes
limits.monthly_token_capintegerYes
next_run_atstring | nullYes
last_run_atstring | nullYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ],
  "schedule": {
    "cron": "örnek",
    "timezone": "Europe/Istanbul"
  },
  "limits": {
    "max_steps": 1,
    "monthly_token_cap": 1
  },
  "next_run_at": "örnek",
  "last_run_at": "örnek",
  "usage": {
    "tokens_this_month": 1,
    "period_start": "örnek"
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "enabled": true,
  "description": "Sipariş durumu güncellemeleri",
  "instructions": "örnek",
  "tools": [
    "list_segments"
  ]
}'

Delete custom AI agent

DELETE/v1/apps/{appId}/custom-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

204 — Success.

No body.

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/custom-agents/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Run custom AI agent now

POST/v1/apps/{appId}/custom-agents/{agentId}/runTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

202 — Success.

Schema: CustomAgentRun

FieldTypeRequiredDescription
idstringYes
agent_idstringYes
triggerenumYesValues: "schedule", "manual"
statusenumYesValues: "pending", "running", "succeeded", "failed", "skipped"
stepsarray<object>Yes
steps[].kindenumYesValues: "tool", "finish"
steps[].toolstringNo
steps[].okbooleanNo
steps[].errorstringNo
steps[].duration_msintegerNo
summarystring | nullYes
input_tokensintegerYes
output_tokensintegerYes
errorstring | nullYes
draftsintegerYes
created_atstringYes
started_atstring | nullYes
finished_atstring | nullYes

Example response:

{
  "status": "pending",
  "id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "agent_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "trigger": "schedule",
  "steps": [
    {
      "kind": "tool",
      "tool": "örnek",
      "ok": true,
      "error": "örnek",
      "duration_ms": 1
    }
  ],
  "summary": "örnek",
  "input_tokens": 1,
  "output_tokens": 1,
  "error": "örnek",
  "drafts": 1,
  "created_at": "örnek",
  "started_at": "örnek",
  "finished_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/custom-agents/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/run" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

List campaigns

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

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
qquerystringNoLength: 1–100"ayse"
statusqueryenumNoValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed""draft"
typequeryenumNoValues: "one_time", "scheduled", "recurring", "automated", "transactional""one_time"
channelqueryenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber""ios_push"
labelquerystringNoLength: 1–40"external_id"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CampaignPage

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

Example response:

{
  "data": [
    {
      "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
      },
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "content": {},
          "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"
      },
      "recurrence": {
        "cron": "xxxxxxxxx",
        "until": "2026-10-17T09:00:00Z",
        "timezone": "Europe/Istanbul"
      },
      "approval": {
        "required": true,
        "pending_action": "send",
        "requested_by": "örnek"
      },
      "stats": {
        "runs": 1,
        "targeted": 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"
      }
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create a campaign

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

Authentication: API key — scope notifications: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/campaigns" \
  -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"
  ]
}'

Campaign details

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update a campaign

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -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"
  ]
}'

Delete a campaign

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Schedule; email list protection 409 → force=true (admin scope)

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
forcequeryenumNoValues: "true", "false""true"
preflight_ackqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ScheduleCampaignDto

FieldTypeRequiredDescription
send_atstring (date-time)No
recurrenceobjectNo
recurrence.cronstringYesLength: 9–100
recurrence.untilstring (date-time) | nullNo
recurrence.timezonestringNoLength: 1–64

Example:

{
  "send_at": "2026-10-17T09:00:00Z",
  "recurrence": {
    "cron": "xxxxxxxxx",
    "until": "2026-10-17T09:00:00Z",
    "timezone": "Europe/Istanbul"
  }
}

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/schedule" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "send_at": "2026-10-17T09:00:00Z",
  "recurrence": {
    "cron": "xxxxxxxxx",
    "until": "2026-10-17T09:00:00Z",
    "timezone": "Europe/Istanbul"
  }
}'

Send now; email list protection 409 → force=true (admin scope)

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
forcequeryenumNoValues: "true", "false""true"
preflight_ackqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/send" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Pre-send check report (brand, banned phrases, links, personalization, KVKK/IYS)

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
check_linksqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CampaignPreflightReport

FieldTypeRequiredDescription
campaign_idstringYes
checked_atstringYes
links_checkedbooleanYes
summaryobjectYes
summary.criticalintegerYes
summary.warningintegerYes
summary.infointegerYes
summary.blockedbooleanYes
findingsarray<object>Yes
findings[].codeenumYesValues: "brand_name_casing", "off_brand_color", "off_brand_font", "banned_phrase", "phishing_term", "link_invalid", "link_insecure_http", "link_unsafe_host", "link_shortener", "link_missing_utm", "link_broken", "link_unreachable", "liquid_syntax_error", "liquid_missing_default", "liquid_unknown_variable", "liquid_undefined_property", "commercial_no_category", "iys_sms_filter_informational", "sms_missing_opt_out", "email_missing_postal_address", "send_time_outside_hours"
findings[].categoryenumYesValues: "brand", "content", "links", "personalization", "compliance"
findings[].severityenumYesValues: "critical", "warning", "info"
findings[].fieldstringNo
findings[].paramsmap<string, string | number>No

Example response:

{
  "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "checked_at": "örnek",
  "links_checked": true,
  "summary": {
    "critical": 1,
    "warning": 1,
    "info": 1,
    "blocked": true
  },
  "findings": [
    {
      "code": "brand_name_casing",
      "category": "brand",
      "severity": "critical",
      "field": "örnek",
      "params": {
        "key": "user_42"
      }
    }
  ]
}

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/preflight" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Email list risk (estimated invalid rate, 7/30-day bounce rate)

GET/v1/apps/{appId}/campaigns/{campaignId}/email-riskTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CampaignEmailRisk

FieldTypeRequiredDescription
appliesbooleanYes
recipientsintegerYes
flagged_invalidintegerYes
sendableintegerYes
validintegerYes
unknownintegerYes
uncheckedintegerYes
estimated_invalid_rationumberYes
max_invalid_rationumberYes
blockedbooleanYes
bounce_rate_7dnumber | nullYes
bounce_rate_30dnumber | nullYes

Example response:

{
  "applies": true,
  "recipients": 1,
  "flagged_invalid": 1,
  "sendable": 1,
  "valid": 1,
  "unknown": 1,
  "unchecked": 1,
  "estimated_invalid_ratio": 1.5,
  "max_invalid_ratio": 1.5,
  "blocked": true,
  "bounce_rate_7d": 1.5,
  "bounce_rate_30d": 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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/email-risk" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Pause

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/pause" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Resume

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/resume" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Cancel

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/cancel" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Duplicate

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/duplicate" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Approve

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
forcequeryenumNoValues: "true", "false""true"
preflight_ackqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/approve" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Statistics

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CampaignStats

FieldTypeRequiredDescription
campaignobjectYes
campaign.idstringYes
campaign.app_idstringYes
campaign.namestringYes
campaign.labelsarray<string>Yes
campaign.categorystring | nullYes
campaign.goalsobjectYes
campaign.goals.primarystringNo
campaign.goals.secondaryarray<string>No
campaign.ab_testobjectYes
campaign.ab_test.enabledbooleanNo
campaign.ab_test.test_percentageintegerNoRange: 1–100
campaign.ab_test.winnerobjectNo
campaign.ab_test.phaseenumNoValues: "testing", "winner_sent"
campaign.ab_test.winner_variant_idstringNo
campaign.ab_test.decided_atstringNo
campaign.ab_test.decided_bystringNo
campaign.ab_test.significanceobjectNo
campaign.variantsarray<object>Yes
campaign.variants[].idstringYes
campaign.variants[].namestringYes
campaign.variants[].weight_percentintegerYes
campaign.variants[].contentmap<string, any> | nullYes
campaign.variants[].is_controlbooleanYes
campaign.variants[].positionintegerYes
campaign.typeenumYesValues: "one_time", "scheduled", "recurring", "automated", "transactional"
campaign.statusenumYesValues: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed"
campaign.audiencemap<string, any>Yes
campaign.contentmap<string, any>Yes
campaign.template_idstring | nullYes
campaign.template_versioninteger | nullYes
campaign.deliveryobjectYes
campaign.delivery.timezone_modeenumNoValues: "immediate", "per_user_timezone", "optimized"
campaign.delivery.delivery_time_of_daystringNo
campaign.delivery.throttle_per_minuteintegerNoRange: 1–1000000
campaign.delivery.ttlintegerNoRange: 60–2419200
campaign.delivery.priority5 | 10No
campaign.delivery.collapse_idstringNoLength: 0–64
campaign.delivery.frequency_cap_exemptbooleanNo
campaign.delivery.frequency_priorityenumNoValues: "low", "normal", "high"
campaign.delivery.global_control_exemptbooleanNo
campaign.delivery.quiet_hours_exemptbooleanNo
campaign.delivery.one_per_userbooleanNo
campaign.recurrenceobject | nullYes
campaign.approvalobjectYes
campaign.approval.requiredbooleanYes
campaign.approval.pending_actionenumNoValues: "send", "schedule"
campaign.approval.requested_bystringNo
campaign.approval.requested_atstringNo
campaign.approval.approved_bystringNo
campaign.approval.approved_atstringNo
campaign.approval.rejected_bystringNo
campaign.approval.rejected_atstringNo
campaign.statsobjectYes
campaign.stats.runsintegerNo
campaign.stats.targetedintegerNo
campaign.stats.suppressedintegerNo
campaign.stats.sentintegerNo
campaign.stats.deliveredintegerNo
campaign.stats.failedintegerNo
campaign.stats.openedintegerNo
campaign.stats.clickedintegerNo
campaign.stats.convertedintegerNo
campaign.stats.bouncedintegerNo
campaign.stats.complainedintegerNo
campaign.stats.unsubscribedintegerNo
campaign.stats.sms_segmentsintegerNo
campaign.send_atstring | nullYes
campaign.next_run_atstring | nullYes
campaign.last_run_atstring | nullYes
campaign.run_countintegerYes
campaign.errorstring | nullYes
campaign.created_bystring | nullYes
campaign.started_atstring | nullYes
campaign.completed_atstring | nullYes
campaign.created_atstringYes
campaign.updated_atstringYes
campaign.estimated_recipientsinteger | nullYes
campaign.preflightobject | nullYes
ratesobjectYes
rates.delivery_ratenumber | nullYes
rates.open_ratenumber | nullYes
rates.click_ratenumber | nullYes
rates.failure_ratenumber | nullYes
rates.conversion_ratenumber | nullYes
goalsarray<object>Yes
goals[].eventstringYes
goals[].primarybooleanYes
goals[].convertedintegerYes
goals[].conversion_ratenumber | nullYes
cardsobject | nullYes
channelsarray<object>Yes
channels[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
channels[].targetedintegerYes
channels[].sentintegerYes
channels[].failedintegerYes
channels[].openedintegerYes
channels[].clickedintegerYes
hourlyarray<object>Yes
hourly[].hourstringYes
hourly[].sentintegerYes
hourly[].failedintegerYes
hourly[].openedintegerYes
hourly[].clickedintegerYes
errorsarray<object>Yes
errors[].codestringYes
errors[].countintegerYes
messagesarray<object>Yes
messages[].idstringYes
messages[].app_idstringYes
messages[].sourceenumYesValues: "campaign", "api", "journey", "test"
messages[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
messages[].idempotency_keystring | nullYes
messages[].namestring | nullYes
messages[].contentmap<string, any>Yes
messages[].targetmap<string, any>Yes
messages[].optionsmap<string, any>Yes
messages[].labelsarray<string>Yes
messages[].categorystring | nullYes
messages[].template_idstring | nullYes
messages[].campaign_idstring | nullYes
messages[].variantsarray<object> | nullYes
messages[].countsobjectYes
messages[].counts.targetedintegerNo
messages[].counts.suppressedintegerNo
messages[].counts.sentintegerNo
messages[].counts.deliveredintegerNo
messages[].counts.failedintegerNo
messages[].counts.erroredintegerNo
messages[].counts.expiredintegerNo
messages[].counts.openedintegerNo
messages[].counts.clickedintegerNo
messages[].counts.convertedintegerNo
messages[].counts.bouncedintegerNo
messages[].counts.complainedintegerNo
messages[].counts.unsubscribedintegerNo
messages[].counts.sms_segmentsintegerNo
messages[].requested_byobjectYes
messages[].requested_by.typeenumYesValues: "api_key", "account", "system"
messages[].requested_by.idstringNo
messages[].errorstring | nullYes
messages[].scheduled_forstring | nullYes
messages[].started_atstring | nullYes
messages[].completed_atstring | nullYes
messages[].created_atstringYes
messages[].updated_atstringYes

Example response:

{
  "channels": [
    "web_push"
  ],
  "campaign": {
    "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
    },
    "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"
    },
    "recurrence": {
      "cron": "xxxxxxxxx",
      "until": "2026-10-17T09:00:00Z",
      "timezone": "Europe/Istanbul"
    },
    "approval": {
      "required": true,
      "pending_action": "send",
      "requested_by": "örnek"
    },
    "stats": {
      "runs": 1,
      "targeted": 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"
    }
  },
  "rates": {
    "delivery_rate": 1.5,
    "open_rate": 1.5,
    "click_rate": 1.5,
    "failure_rate": 1.5,
    "conversion_rate": 1.5
  },
  "goals": [
    {
      "event": "purchase",
      "primary": true,
      "converted": 1,
      "conversion_rate": 1.5
    }
  ],
  "cards": {
    "created": 1,
    "viewed": 1,
    "clicked": 1,
    "dismissed": 1,
    "view_rate": 1.5,
    "click_rate": 1.5
  },
  "hourly": [
    {
      "hour": "örnek",
      "sent": 1,
      "failed": 1,
      "opened": 1,
      "clicked": 1
    }
  ],
  "errors": [
    {
      "code": "örnek",
      "count": 1
    }
  ],
  "messages": [
    {
      "name": "Sipariş bildirimleri",
      "target": {
        "include_external_ids": [
          "user_42"
        ]
      },
      "status": "queued",
      "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "source": "campaign",
      "idempotency_key": "order-1001",
      "content": {
        "contents": {
          "tr": "Siparişiniz yola çıktı"
        }
      },
      "options": {},
      "labels": [
        "promo"
      ],
      "category": "örnek",
      "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "is_control": true
        }
      ],
      "counts": {
        "targeted": 1,
        "suppressed": 1
      },
      "requested_by": {
        "type": "api_key",
        "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "error": "örnek",
      "scheduled_for": "örnek",
      "started_at": "örnek",
      "completed_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/stats" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

A/B variant comparison

GET/v1/apps/{appId}/campaigns/{campaignId}/variants/statsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CampaignVariantStats

FieldTypeRequiredDescription
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[].variant_idstringYes
variants[].namestringYes
variants[].weight_percentintegerYes
variants[].is_controlbooleanYes
variants[].targetedintegerYes
variants[].sentintegerYes
variants[].deliveredintegerYes
variants[].openedintegerYes
variants[].clickedintegerYes
variants[].convertedintegerYes
variants[].holdoutintegerYes
variants[].open_ratenumberYes
variants[].click_ratenumberYes
variants[].conversion_ratenumberYes
variants[].goalsarray<object>Yes
variants[].goals[].eventstringYes
variants[].goals[].primarybooleanYes
variants[].goals[].convertedintegerYes
variants[].goals[].conversion_ratenumberYes
leaderstring | nullYes
significanceobjectYes
significance.p_valuenumberYes
significance.significantbooleanYes
significance.metricstringYes

Example response:

{
  "ab_test": {
    "enabled": true,
    "test_percentage": 1,
    "winner": {
      "mode": "manual",
      "metric": "open_rate",
      "evaluate_after_minutes": 5
    },
    "phase": "testing"
  },
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "is_control": true,
      "targeted": 1,
      "sent": 1,
      "delivered": 1,
      "opened": 1,
      "clicked": 1,
      "converted": 1,
      "holdout": 1,
      "open_rate": 1.5,
      "click_rate": 1.5,
      "conversion_rate": 1.5,
      "goals": [
        {
          "event": "purchase",
          "primary": true,
          "converted": 1,
          "conversion_rate": 1.5
        }
      ]
    }
  ],
  "leader": "örnek",
  "significance": {
    "p_value": 149.9,
    "significant": true,
    "metric": "örnek"
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/variants/stats" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Pick the A/B winner

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SelectWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–∞

Example:

{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

Per-subscriber deliveries

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
app_idquerystringNo"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled""pending"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: DeliveryList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstringYes
data[].subscription_idstringYes
data[].user_idstring | nullYes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].providerstring | nullYes
data[].statusenumYesValues: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled"
data[].attempt_countintegerYes
data[].provider_message_idstring | nullYes
data[].error_codestring | nullYes
data[].error_messagestring | nullYes
data[].suppression_reasonstring | nullYes
data[].send_afterstring | nullYes
data[].sent_atstring | nullYes
data[].delivered_atstring | nullYes
data[].opened_atstring | nullYes
data[].clicked_atstring | nullYes
data[].failed_atstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "channel": "ios_push",
      "status": "pending",
      "send_after": "örnek",
      "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "provider": "örnek",
      "attempt_count": 1,
      "provider_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "error_code": "örnek",
      "error_message": "örnek",
      "suppression_reason": "örnek",
      "sent_at": "örnek",
      "delivered_at": "örnek",
      "opened_at": "örnek",
      "clicked_at": "örnek",
      "failed_at": "örnek",
      "created_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Resend to failed deliveries

POST/v1/apps/{appId}/campaigns/{campaignId}/resend-failedTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

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/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/resend-failed" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Campaign runs

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

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

Parameters

NameInTypeRequiredDescriptionExample
campaignIdpathstringYes"cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: MessageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].sourceenumYesValues: "campaign", "api", "journey", "test"
data[].statusenumYesValues: "queued", "processing", "completed", "cancelled", "failed"
data[].idempotency_keystring | nullYes
data[].namestring | nullYes
data[].contentmap<string, any>Yes
data[].targetmap<string, any>Yes
data[].optionsmap<string, any>Yes
data[].labelsarray<string>Yes
data[].categorystring | nullYes
data[].template_idstring | nullYes
data[].campaign_idstring | nullYes
data[].variantsarray<object> | nullYes
data[].countsobjectYes
data[].counts.targetedintegerNo
data[].counts.suppressedintegerNo
data[].counts.sentintegerNo
data[].counts.deliveredintegerNo
data[].counts.failedintegerNo
data[].counts.erroredintegerNo
data[].counts.expiredintegerNo
data[].counts.openedintegerNo
data[].counts.clickedintegerNo
data[].counts.convertedintegerNo
data[].counts.bouncedintegerNo
data[].counts.complainedintegerNo
data[].counts.unsubscribedintegerNo
data[].counts.sms_segmentsintegerNo
data[].requested_byobjectYes
data[].requested_by.typeenumYesValues: "api_key", "account", "system"
data[].requested_by.idstringNo
data[].errorstring | nullYes
data[].scheduled_forstring | nullYes
data[].started_atstring | nullYes
data[].completed_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "target": {
        "include_external_ids": [
          "user_42"
        ]
      },
      "status": "queued",
      "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "source": "campaign",
      "idempotency_key": "order-1001",
      "content": {
        "contents": {
          "tr": "Siparişiniz yola çıktı"
        }
      },
      "options": {},
      "labels": [
        "promo"
      ],
      "category": "örnek",
      "template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "is_control": true
        }
      ],
      "counts": {
        "targeted": 1,
        "suppressed": 1
      },
      "requested_by": {
        "type": "api_key",
        "id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
      },
      "error": "örnek",
      "scheduled_for": "örnek",
      "started_at": "örnek",
      "completed_at": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/messages" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page