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
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/custom-agents | Custom AI agents |
POST | /v1/apps/{appId}/custom-agents | Create custom AI agent |
GET | /v1/apps/{appId}/custom-agents/runs | Custom AI agent runs |
GET | /v1/apps/{appId}/custom-agents/drafts | Custom 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}/run | Run custom AI agent now |
GET | /v1/apps/{appId}/campaigns | List campaigns |
POST | /v1/apps/{appId}/campaigns | Create 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}/schedule | Schedule; email list protection 409 → force=true (admin scope) |
POST | /v1/apps/{appId}/campaigns/{campaignId}/send | Send now; email list protection 409 → force=true (admin scope) |
POST | /v1/apps/{appId}/campaigns/{campaignId}/preflight | Pre-send check report (brand, banned phrases, links, personalization, KVKK/IYS) |
GET | /v1/apps/{appId}/campaigns/{campaignId}/email-risk | Email list risk (estimated invalid rate, 7/30-day bounce rate) |
POST | /v1/apps/{appId}/campaigns/{campaignId}/pause | Pause |
POST | /v1/apps/{appId}/campaigns/{campaignId}/resume | Resume |
POST | /v1/apps/{appId}/campaigns/{campaignId}/cancel | Cancel |
POST | /v1/apps/{appId}/campaigns/{campaignId}/duplicate | Duplicate |
POST | /v1/apps/{appId}/campaigns/{campaignId}/approve | Approve |
GET | /v1/apps/{appId}/campaigns/{campaignId}/stats | Statistics |
GET | /v1/apps/{appId}/campaigns/{campaignId}/variants/stats | A/B variant comparison |
POST | /v1/apps/{appId}/campaigns/{campaignId}/winner | Pick the A/B winner |
GET | /v1/apps/{appId}/campaigns/{campaignId}/deliveries | Per-subscriber deliveries |
POST | /v1/apps/{appId}/campaigns/{campaignId}/resend-failed | Resend to failed deliveries |
GET | /v1/apps/{appId}/campaigns/{campaignId}/messages | Campaign runs |
Details
Custom AI agents
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CustomAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | Yes | |
data[].enabled | boolean | Yes | |
data[].instructions | string | Yes | |
data[].tools | array<enum> | Yes | |
data[].schedule | object | null | Yes | |
data[].limits | object | Yes | |
data[].limits.max_steps | integer | Yes | |
data[].limits.monthly_token_cap | integer | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].usage | object | Yes | |
data[].usage.tokens_this_month | integer | Yes | |
data[].usage.period_start | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateCustomAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | No | Length: 0–300 |
enabled | boolean | No | |
instructions | string | No | Length: 0–4000 |
tools | array<enum> | No | Items: 0–5 |
schedule | object | null | No | |
limits | object | No | |
limits.max_steps | integer | No | Range: 1–10 |
limits.monthly_token_cap | integer | No | Range: 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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
instructions | string | Yes | |
tools | array<enum> | Yes | |
schedule | object | null | Yes | |
limits | object | Yes | |
limits.max_steps | integer | Yes | |
limits.monthly_token_cap | integer | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agent_id | query | string | No | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
status | query | enum | No | Values: "pending", "running", "succeeded", "failed", "skipped" | "pending" |
limit | query | integer | No | Range: 1–100 | 50 |
cursor | query | string | No | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CustomAgentRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "pending", "running", "succeeded", "failed", "skipped" |
data[].steps | array<object> | Yes | |
data[].steps[].kind | enum | Yes | Values: "tool", "finish" |
data[].steps[].tool | string | No | |
data[].steps[].ok | boolean | No | |
data[].steps[].error | string | No | |
data[].steps[].duration_ms | integer | No | |
data[].summary | string | null | Yes | |
data[].input_tokens | integer | Yes | |
data[].output_tokens | integer | Yes | |
data[].error | string | null | Yes | |
data[].drafts | integer | Yes | |
data[].created_at | string | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agent_id | query | string | No | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
run_id | query | string | No | "run_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
status | query | enum | No | Values: "pending", "applied", "dismissed" | "pending" |
limit | query | integer | No | Range: 1–100 | 50 |
cursor | query | string | No | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CustomAgentDraftList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].run_id | string | Yes | |
data[].kind | enum | Yes | Values: "segment", "campaign" |
data[].status | enum | Yes | Values: "pending", "applied", "dismissed" |
data[].payload | map<string, any> | Yes | |
data[].result_id | string | null | Yes | |
data[].decided_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CustomAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
instructions | string | Yes | |
tools | array<enum> | Yes | |
schedule | object | null | Yes | |
limits | object | Yes | |
limits.max_steps | integer | Yes | |
limits.monthly_token_cap | integer | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateCustomAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | No | Length: 0–300 |
enabled | boolean | No | |
instructions | string | No | Length: 0–4000 |
tools | array<enum> | No | Items: 0–5 |
schedule | object | null | No | |
limits | object | No | |
limits.max_steps | integer | No | Range: 1–10 |
limits.monthly_token_cap | integer | No | Range: 1000–20000000 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"description": "Sipariş durumu güncellemeleri",
"instructions": "örnek",
"tools": [
"list_segments"
]
}Responses
200 — Success.
Schema: CustomAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
description | string | Yes | |
enabled | boolean | Yes | |
instructions | string | Yes | |
tools | array<enum> | Yes | |
schedule | object | null | Yes | |
limits | object | Yes | |
limits.max_steps | integer | Yes | |
limits.monthly_token_cap | integer | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: CustomAgentRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
agent_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "pending", "running", "succeeded", "failed", "skipped" |
steps | array<object> | Yes | |
steps[].kind | enum | Yes | Values: "tool", "finish" |
steps[].tool | string | No | |
steps[].ok | boolean | No | |
steps[].error | string | No | |
steps[].duration_ms | integer | No | |
summary | string | null | Yes | |
input_tokens | integer | Yes | |
output_tokens | integer | Yes | |
error | string | null | Yes | |
drafts | integer | Yes | |
created_at | string | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
q | query | string | No | Length: 1–100 | "ayse" |
status | query | enum | No | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" | "draft" |
type | query | enum | No | Values: "one_time", "scheduled", "recurring", "automated", "transactional" | "one_time" |
channel | query | enum | No | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" | "ios_push" |
label | query | string | No | Length: 1–40 | "external_id" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CampaignPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].labels | array<string> | Yes | |
data[].category | string | null | Yes | |
data[].goals | object | Yes | |
data[].goals.primary | string | No | |
data[].goals.secondary | array<string> | No | |
data[].ab_test | object | Yes | |
data[].ab_test.enabled | boolean | No | |
data[].ab_test.test_percentage | integer | No | Range: 1–100 |
data[].ab_test.winner | object | No | |
data[].ab_test.phase | enum | No | Values: "testing", "winner_sent" |
data[].ab_test.winner_variant_id | string | No | |
data[].ab_test.decided_at | string | No | |
data[].ab_test.decided_by | string | No | |
data[].ab_test.significance | object | No | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].name | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].content | map<string, any> | null | Yes | |
data[].variants[].is_control | boolean | Yes | |
data[].variants[].position | integer | Yes | |
data[].type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
data[].status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
data[].audience | map<string, any> | Yes | |
data[].content | map<string, any> | Yes | |
data[].template_id | string | null | Yes | |
data[].template_version | integer | null | Yes | |
data[].delivery | object | Yes | |
data[].delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
data[].delivery.delivery_time_of_day | string | No | |
data[].delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
data[].delivery.ttl | integer | No | Range: 60–2419200 |
data[].delivery.priority | 5 | 10 | No | |
data[].delivery.collapse_id | string | No | Length: 0–64 |
data[].delivery.frequency_cap_exempt | boolean | No | |
data[].delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
data[].delivery.global_control_exempt | boolean | No | |
data[].delivery.quiet_hours_exempt | boolean | No | |
data[].delivery.one_per_user | boolean | No | |
data[].recurrence | object | null | Yes | |
data[].approval | object | Yes | |
data[].approval.required | boolean | Yes | |
data[].approval.pending_action | enum | No | Values: "send", "schedule" |
data[].approval.requested_by | string | No | |
data[].approval.requested_at | string | No | |
data[].approval.approved_by | string | No | |
data[].approval.approved_at | string | No | |
data[].approval.rejected_by | string | No | |
data[].approval.rejected_at | string | No | |
data[].stats | object | Yes | |
data[].stats.runs | integer | No | |
data[].stats.targeted | integer | No | |
data[].stats.suppressed | integer | No | |
data[].stats.sent | integer | No | |
data[].stats.delivered | integer | No | |
data[].stats.failed | integer | No | |
data[].stats.opened | integer | No | |
data[].stats.clicked | integer | No | |
data[].stats.converted | integer | No | |
data[].stats.bounced | integer | No | |
data[].stats.complained | integer | No | |
data[].stats.unsubscribed | integer | No | |
data[].stats.sms_segments | integer | No | |
data[].send_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].run_count | integer | Yes | |
data[].error | string | null | Yes | |
data[].created_by | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].completed_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].estimated_recipients | integer | null | Yes | |
data[].preflight | object | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–120 |
type | enum | No | Values: "one_time", "scheduled", "recurring" |
audience | object | No | |
audience.all | boolean | No | |
audience.segments | array<string> | No | |
audience.exclude_segments | array<string> | No | |
audience.filters | object | No | Filter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7). |
audience.filters.all | array<object> | No | |
audience.filters.any | array<object> | No | |
audience.filters.none | array<object> | No | |
audience.channels | array<enum> | No | |
audience.test_devices_only | boolean | No | |
content | object | No | Same schema as messages.content (headings, contents, url, buttons…) |
labels | array<string> | No | Items: 0–10 |
category | string | null | No | Preference category key; users who opted out are suppressed |
goals | object | No | Conversion goals (ADR-0080): the primary goal decides the A/B winner; the events must be defined as conversion events. |
goals.primary | string | No | Length: 0–100 |
goals.secondary | array<string> | No | Items: 0–2 |
ab_test | object | No | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | No | Values: "manual", "auto" |
ab_test.winner.metric | enum | No | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–∞ |
variants | array<object> | No | A/B variants (weights sum to 100; at most one is_control). Items: 0–10 |
variants[].id | string | No | |
variants[].name | string | Yes | Length: 0–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].content | object | null | No | |
variants[].is_control | boolean | No | |
template_id | string | No | |
template_version | integer | No | |
delivery | object | No | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | |
delivery.ttl | integer | No | |
delivery.priority | enum | No | Values: 5, 10 |
delivery.collapse_id | string | No | |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | No | |
recurrence.cron | string | No | |
recurrence.until | string (date-time) | null | No | |
recurrence.timezone | string | No | |
send_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"audience": {
"channels": [
"ios_push"
],
"all": false,
"segments": [
"örnek"
]
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"labels": [
"promo"
]
}Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a campaign
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–120 |
type | enum | No | Values: "one_time", "scheduled", "recurring" |
audience | object | No | |
audience.all | boolean | No | |
audience.segments | array<string> | No | |
audience.exclude_segments | array<string> | No | |
audience.filters | object | No | Filter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7). |
audience.filters.all | array<object> | No | |
audience.filters.any | array<object> | No | |
audience.filters.none | array<object> | No | |
audience.channels | array<enum> | No | |
audience.test_devices_only | boolean | No | |
content | object | No | Same schema as messages.content (headings, contents, url, buttons…) |
labels | array<string> | No | Items: 0–10 |
category | string | null | No | Preference category key; users who opted out are suppressed |
goals | object | No | Conversion goals (ADR-0080): the primary goal decides the A/B winner; the events must be defined as conversion events. |
goals.primary | string | No | Length: 0–100 |
goals.secondary | array<string> | No | Items: 0–2 |
ab_test | object | No | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | No | Values: "manual", "auto" |
ab_test.winner.metric | enum | No | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–∞ |
variants | array<object> | No | A/B variants (weights sum to 100; at most one is_control). Items: 0–10 |
variants[].id | string | No | |
variants[].name | string | Yes | Length: 0–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].content | object | null | No | |
variants[].is_control | boolean | No | |
template_id | string | No | |
template_version | integer | No | |
delivery | object | No | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | |
delivery.ttl | integer | No | |
delivery.priority | enum | No | Values: 5, 10 |
delivery.collapse_id | string | No | |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | No | |
recurrence.cron | string | No | |
recurrence.until | string (date-time) | null | No | |
recurrence.timezone | string | No | |
send_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"audience": {
"channels": [
"ios_push"
],
"all": false,
"segments": [
"örnek"
]
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"labels": [
"promo"
]
}Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X 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
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Schedule; email list protection 409 → force=true (admin scope)
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
force | query | enum | No | Values: "true", "false" | "true" |
preflight_ack | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ScheduleCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
send_at | string (date-time) | No | |
recurrence | object | No | |
recurrence.cron | string | Yes | Length: 9–100 |
recurrence.until | string (date-time) | null | No | |
recurrence.timezone | string | No | Length: 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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/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)
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
force | query | enum | No | Values: "true", "false" | "true" |
preflight_ack | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/send" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Pre-send check report (brand, banned phrases, links, personalization, KVKK/IYS)
Authentication: API key — scope notifications:write or mcp:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
check_links | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CampaignPreflightReport
| Field | Type | Required | Description |
|---|---|---|---|
campaign_id | string | Yes | |
checked_at | string | Yes | |
links_checked | boolean | Yes | |
summary | object | Yes | |
summary.critical | integer | Yes | |
summary.warning | integer | Yes | |
summary.info | integer | Yes | |
summary.blocked | boolean | Yes | |
findings | array<object> | Yes | |
findings[].code | enum | Yes | Values: "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[].category | enum | Yes | Values: "brand", "content", "links", "personalization", "compliance" |
findings[].severity | enum | Yes | Values: "critical", "warning", "info" |
findings[].field | string | No | |
findings[].params | map<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)
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CampaignEmailRisk
| Field | Type | Required | Description |
|---|---|---|---|
applies | boolean | Yes | |
recipients | integer | Yes | |
flagged_invalid | integer | Yes | |
sendable | integer | Yes | |
valid | integer | Yes | |
unknown | integer | Yes | |
unchecked | integer | Yes | |
estimated_invalid_ratio | number | Yes | |
max_invalid_ratio | number | Yes | |
blocked | boolean | Yes | |
bounce_rate_7d | number | null | Yes | |
bounce_rate_30d | number | null | Yes |
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
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/pause" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Resume
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/resume" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Cancel
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/cancel" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Duplicate
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/duplicate" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Approve
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
force | query | enum | No | Values: "true", "false" | "true" |
preflight_ack | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/approve" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Statistics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CampaignStats
| Field | Type | Required | Description |
|---|---|---|---|
campaign | object | Yes | |
campaign.id | string | Yes | |
campaign.app_id | string | Yes | |
campaign.name | string | Yes | |
campaign.labels | array<string> | Yes | |
campaign.category | string | null | Yes | |
campaign.goals | object | Yes | |
campaign.goals.primary | string | No | |
campaign.goals.secondary | array<string> | No | |
campaign.ab_test | object | Yes | |
campaign.ab_test.enabled | boolean | No | |
campaign.ab_test.test_percentage | integer | No | Range: 1–100 |
campaign.ab_test.winner | object | No | |
campaign.ab_test.phase | enum | No | Values: "testing", "winner_sent" |
campaign.ab_test.winner_variant_id | string | No | |
campaign.ab_test.decided_at | string | No | |
campaign.ab_test.decided_by | string | No | |
campaign.ab_test.significance | object | No | |
campaign.variants | array<object> | Yes | |
campaign.variants[].id | string | Yes | |
campaign.variants[].name | string | Yes | |
campaign.variants[].weight_percent | integer | Yes | |
campaign.variants[].content | map<string, any> | null | Yes | |
campaign.variants[].is_control | boolean | Yes | |
campaign.variants[].position | integer | Yes | |
campaign.type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
campaign.status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
campaign.audience | map<string, any> | Yes | |
campaign.content | map<string, any> | Yes | |
campaign.template_id | string | null | Yes | |
campaign.template_version | integer | null | Yes | |
campaign.delivery | object | Yes | |
campaign.delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
campaign.delivery.delivery_time_of_day | string | No | |
campaign.delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
campaign.delivery.ttl | integer | No | Range: 60–2419200 |
campaign.delivery.priority | 5 | 10 | No | |
campaign.delivery.collapse_id | string | No | Length: 0–64 |
campaign.delivery.frequency_cap_exempt | boolean | No | |
campaign.delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
campaign.delivery.global_control_exempt | boolean | No | |
campaign.delivery.quiet_hours_exempt | boolean | No | |
campaign.delivery.one_per_user | boolean | No | |
campaign.recurrence | object | null | Yes | |
campaign.approval | object | Yes | |
campaign.approval.required | boolean | Yes | |
campaign.approval.pending_action | enum | No | Values: "send", "schedule" |
campaign.approval.requested_by | string | No | |
campaign.approval.requested_at | string | No | |
campaign.approval.approved_by | string | No | |
campaign.approval.approved_at | string | No | |
campaign.approval.rejected_by | string | No | |
campaign.approval.rejected_at | string | No | |
campaign.stats | object | Yes | |
campaign.stats.runs | integer | No | |
campaign.stats.targeted | integer | No | |
campaign.stats.suppressed | integer | No | |
campaign.stats.sent | integer | No | |
campaign.stats.delivered | integer | No | |
campaign.stats.failed | integer | No | |
campaign.stats.opened | integer | No | |
campaign.stats.clicked | integer | No | |
campaign.stats.converted | integer | No | |
campaign.stats.bounced | integer | No | |
campaign.stats.complained | integer | No | |
campaign.stats.unsubscribed | integer | No | |
campaign.stats.sms_segments | integer | No | |
campaign.send_at | string | null | Yes | |
campaign.next_run_at | string | null | Yes | |
campaign.last_run_at | string | null | Yes | |
campaign.run_count | integer | Yes | |
campaign.error | string | null | Yes | |
campaign.created_by | string | null | Yes | |
campaign.started_at | string | null | Yes | |
campaign.completed_at | string | null | Yes | |
campaign.created_at | string | Yes | |
campaign.updated_at | string | Yes | |
campaign.estimated_recipients | integer | null | Yes | |
campaign.preflight | object | null | Yes | |
rates | object | Yes | |
rates.delivery_rate | number | null | Yes | |
rates.open_rate | number | null | Yes | |
rates.click_rate | number | null | Yes | |
rates.failure_rate | number | null | Yes | |
rates.conversion_rate | number | null | Yes | |
goals | array<object> | Yes | |
goals[].event | string | Yes | |
goals[].primary | boolean | Yes | |
goals[].converted | integer | Yes | |
goals[].conversion_rate | number | null | Yes | |
cards | object | null | Yes | |
channels | array<object> | Yes | |
channels[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
channels[].targeted | integer | Yes | |
channels[].sent | integer | Yes | |
channels[].failed | integer | Yes | |
channels[].opened | integer | Yes | |
channels[].clicked | integer | Yes | |
hourly | array<object> | Yes | |
hourly[].hour | string | Yes | |
hourly[].sent | integer | Yes | |
hourly[].failed | integer | Yes | |
hourly[].opened | integer | Yes | |
hourly[].clicked | integer | Yes | |
errors | array<object> | Yes | |
errors[].code | string | Yes | |
errors[].count | integer | Yes | |
messages | array<object> | Yes | |
messages[].id | string | Yes | |
messages[].app_id | string | Yes | |
messages[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
messages[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
messages[].idempotency_key | string | null | Yes | |
messages[].name | string | null | Yes | |
messages[].content | map<string, any> | Yes | |
messages[].target | map<string, any> | Yes | |
messages[].options | map<string, any> | Yes | |
messages[].labels | array<string> | Yes | |
messages[].category | string | null | Yes | |
messages[].template_id | string | null | Yes | |
messages[].campaign_id | string | null | Yes | |
messages[].variants | array<object> | null | Yes | |
messages[].counts | object | Yes | |
messages[].counts.targeted | integer | No | |
messages[].counts.suppressed | integer | No | |
messages[].counts.sent | integer | No | |
messages[].counts.delivered | integer | No | |
messages[].counts.failed | integer | No | |
messages[].counts.errored | integer | No | |
messages[].counts.expired | integer | No | |
messages[].counts.opened | integer | No | |
messages[].counts.clicked | integer | No | |
messages[].counts.converted | integer | No | |
messages[].counts.bounced | integer | No | |
messages[].counts.complained | integer | No | |
messages[].counts.unsubscribed | integer | No | |
messages[].counts.sms_segments | integer | No | |
messages[].requested_by | object | Yes | |
messages[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
messages[].requested_by.id | string | No | |
messages[].error | string | null | Yes | |
messages[].scheduled_for | string | null | Yes | |
messages[].started_at | string | null | Yes | |
messages[].completed_at | string | null | Yes | |
messages[].created_at | string | Yes | |
messages[].updated_at | string | Yes |
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
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CampaignVariantStats
| Field | Type | Required | Description |
|---|---|---|---|
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].variant_id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].is_control | boolean | Yes | |
variants[].targeted | integer | Yes | |
variants[].sent | integer | Yes | |
variants[].delivered | integer | Yes | |
variants[].opened | integer | Yes | |
variants[].clicked | integer | Yes | |
variants[].converted | integer | Yes | |
variants[].holdout | integer | Yes | |
variants[].open_rate | number | Yes | |
variants[].click_rate | number | Yes | |
variants[].conversion_rate | number | Yes | |
variants[].goals | array<object> | Yes | |
variants[].goals[].event | string | Yes | |
variants[].goals[].primary | boolean | Yes | |
variants[].goals[].converted | integer | Yes | |
variants[].goals[].conversion_rate | number | Yes | |
leader | string | null | Yes | |
significance | object | Yes | |
significance.p_value | number | Yes | |
significance.significant | boolean | Yes | |
significance.metric | string | Yes |
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
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SelectWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–∞ |
Example:
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Per-subscriber deliveries
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
app_id | query | string | No | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
status | query | enum | No | Values: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" | "pending" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: DeliveryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | Yes | |
data[].subscription_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].provider | string | null | Yes | |
data[].status | enum | Yes | Values: "pending", "sent", "delivered", "failed", "bounced", "suppressed", "expired", "cancelled" |
data[].attempt_count | integer | Yes | |
data[].provider_message_id | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].error_message | string | null | Yes | |
data[].suppression_reason | string | null | Yes | |
data[].send_after | string | null | Yes | |
data[].sent_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].opened_at | string | null | Yes | |
data[].clicked_at | string | null | Yes | |
data[].failed_at | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Campaign
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
labels | array<string> | Yes | |
category | string | null | Yes | |
goals | object | Yes | |
goals.primary | string | No | |
goals.secondary | array<string> | No | |
ab_test | object | Yes | |
ab_test.enabled | boolean | No | |
ab_test.test_percentage | integer | No | Range: 1–100 |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.metric | enum | Yes | Values: "open_rate", "click_rate", "conversion_rate" |
ab_test.winner.evaluate_after_minutes | integer | No | Range: 5–10080 |
ab_test.phase | enum | No | Values: "testing", "winner_sent" |
ab_test.winner_variant_id | string | No | |
ab_test.decided_at | string | No | |
ab_test.decided_by | string | No | |
ab_test.significance | object | No | |
ab_test.significance.p_value | number | Yes | |
ab_test.significance.significant | boolean | Yes | |
ab_test.significance.metric | string | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | |
variants[].name | string | Yes | |
variants[].weight_percent | integer | Yes | |
variants[].content | map<string, any> | null | Yes | |
variants[].is_control | boolean | Yes | |
variants[].position | integer | Yes | |
type | enum | Yes | Values: "one_time", "scheduled", "recurring", "automated", "transactional" |
status | enum | Yes | Values: "draft", "scheduled", "running", "paused", "completed", "cancelled", "failed" |
audience | map<string, any> | Yes | |
content | map<string, any> | Yes | |
template_id | string | null | Yes | |
template_version | integer | null | Yes | |
delivery | object | Yes | |
delivery.timezone_mode | enum | No | Values: "immediate", "per_user_timezone", "optimized" |
delivery.delivery_time_of_day | string | No | |
delivery.throttle_per_minute | integer | No | Range: 1–1000000 |
delivery.ttl | integer | No | Range: 60–2419200 |
delivery.priority | 5 | 10 | No | |
delivery.collapse_id | string | No | Length: 0–64 |
delivery.frequency_cap_exempt | boolean | No | |
delivery.frequency_priority | enum | No | Values: "low", "normal", "high" |
delivery.global_control_exempt | boolean | No | |
delivery.quiet_hours_exempt | boolean | No | |
delivery.one_per_user | boolean | No | |
recurrence | object | null | Yes | |
approval | object | Yes | |
approval.required | boolean | Yes | |
approval.pending_action | enum | No | Values: "send", "schedule" |
approval.requested_by | string | No | |
approval.requested_at | string | No | |
approval.approved_by | string | No | |
approval.approved_at | string | No | |
approval.rejected_by | string | No | |
approval.rejected_at | string | No | |
stats | object | Yes | |
stats.runs | integer | No | |
stats.targeted | integer | No | |
stats.suppressed | integer | No | |
stats.sent | integer | No | |
stats.delivered | integer | No | |
stats.failed | integer | No | |
stats.opened | integer | No | |
stats.clicked | integer | No | |
stats.converted | integer | No | |
stats.bounced | integer | No | |
stats.complained | integer | No | |
stats.unsubscribed | integer | No | |
stats.sms_segments | integer | No | |
send_at | string | null | Yes | |
next_run_at | string | null | Yes | |
last_run_at | string | null | Yes | |
run_count | integer | Yes | |
error | string | null | Yes | |
created_by | string | null | Yes | |
started_at | string | null | Yes | |
completed_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
estimated_recipients | integer | null | Yes | |
preflight | object | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"type": "one_time",
"status": "draft",
"id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"labels": [
"promo"
],
"category": "örnek",
"goals": {
"primary": "örnek",
"secondary": [
"örnek"
]
},
"ab_test": {
"enabled": true,
"test_percentage": 1,
"winner": {
"mode": "manual",
"metric": "open_rate",
"evaluate_after_minutes": 5
},
"phase": "testing"
},
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"is_control": true,
"position": 1
}
],
"audience": {
"key": "örnek"
},
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_version": 1,
"delivery": {
"ttl": 86400,
"timezone_mode": "immediate",
"delivery_time_of_day": "değer",
"throttle_per_minute": 1
},
"recurrence": {
"cron": "xxxxxxxxx",
"until": "2026-10-17T09:00:00Z",
"timezone": "Europe/Istanbul"
},
"approval": {
"required": true,
"pending_action": "send",
"requested_by": "örnek",
"requested_at": "örnek",
"approved_by": "örnek"
},
"stats": {
"runs": 1,
"targeted": 1,
"suppressed": 1,
"sent": 1
},
"send_at": "örnek",
"next_run_at": "örnek",
"last_run_at": "örnek",
"run_count": 1,
"error": "örnek",
"created_by": "örnek",
"started_at": "örnek",
"completed_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"estimated_recipients": 1,
"preflight": {
"checked_at": "örnek",
"summary": {
"critical": 1,
"warning": 1,
"info": 1,
"blocked": true
},
"codes": [
"örnek"
],
"acknowledged_by": "örnek",
"acknowledged_at": "örnek"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/resend-failed" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Campaign runs
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: MessageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].source | enum | Yes | Values: "campaign", "api", "journey", "test" |
data[].status | enum | Yes | Values: "queued", "processing", "completed", "cancelled", "failed" |
data[].idempotency_key | string | null | Yes | |
data[].name | string | null | Yes | |
data[].content | map<string, any> | Yes | |
data[].target | map<string, any> | Yes | |
data[].options | map<string, any> | Yes | |
data[].labels | array<string> | Yes | |
data[].category | string | null | Yes | |
data[].template_id | string | null | Yes | |
data[].campaign_id | string | null | Yes | |
data[].variants | array<object> | null | Yes | |
data[].counts | object | Yes | |
data[].counts.targeted | integer | No | |
data[].counts.suppressed | integer | No | |
data[].counts.sent | integer | No | |
data[].counts.delivered | integer | No | |
data[].counts.failed | integer | No | |
data[].counts.errored | integer | No | |
data[].counts.expired | integer | No | |
data[].counts.opened | integer | No | |
data[].counts.clicked | integer | No | |
data[].counts.converted | integer | No | |
data[].counts.bounced | integer | No | |
data[].counts.complained | integer | No | |
data[].counts.unsubscribed | integer | No | |
data[].counts.sms_segments | integer | No | |
data[].requested_by | object | Yes | |
data[].requested_by.type | enum | Yes | Values: "api_key", "account", "system" |
data[].requested_by.id | string | No | |
data[].error | string | null | Yes | |
data[].scheduled_for | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].completed_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"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"Templates
Templates — 10 operations (GET /v1/apps/{appId}/templates, POST /v1/apps/{appId}/templates, GET /v1/apps/{appId}/templates/{templateId}, …). Generated from the OpenAPI 3.1.0 contract.
Journeys
Journeys — 20 operations (GET /v1/apps/{appId}/journeys, POST /v1/apps/{appId}/journeys, GET /v1/apps/{appId}/journeys/{journeyId}, …). Generated from the OpenAPI 3.1.0 contract.