In-app messages
In-app messages — 7 operations (GET /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, …). Generated from the OpenAPI 3.1.0 contract.
In-app message definitions (modal/banner/full screen), triggers, status changes and A/B winner selection.
Base URL: https://api.pushizo.com · Tag: in-app · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/in-app-messages | In-app messages (status filter; statistics included) |
POST | /v1/apps/{appId}/in-app-messages | Create an in-app message (draft) |
GET | /v1/apps/{appId}/in-app-messages/{messageId} | In-app message details and statistics |
PATCH | /v1/apps/{appId}/in-app-messages/{messageId} | Edit an in-app message |
DELETE | /v1/apps/{appId}/in-app-messages/{messageId} | Delete an in-app message |
POST | /v1/apps/{appId}/in-app-messages/{messageId}/status | Publish / pause / archive |
POST | /v1/apps/{appId}/in-app-messages/{messageId}/winner | Pick the A/B winner manually |
Details
In-app messages (status filter; statistics included)
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…" |
status | query | enum | No | Values: "draft", "active", "paused", "archived" | "draft" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: InAppMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].status | enum | Yes | Values: "draft", "active", "paused", "archived" |
data[].priority | integer | Yes | |
data[].triggers | array<object> | Yes | |
data[].trigger_groups | array<array<object>> | null | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | Length: 1–64 |
data[].variants[].name | string | Yes | Length: 1–60 |
data[].variants[].weight_percent | integer | Yes | Range: 1–99 |
data[].variants[].display | object | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | No | |
data[].display.text_color | string | No | |
data[].display.dismissible | boolean | No | |
data[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
data[].display.content_type | enum | No | Values: "blocks", "html" |
data[].display.html | map<string, string> | No | |
data[].display.html_height | integer | No | Range: 40–2000 |
data[].display.blocks | array<object> | Yes | Items: 0–12 |
data[].audience | object | Yes | |
data[].audience.included_segments | array<string> | No | Items: 0–20 |
data[].audience.excluded_segments | array<string> | No | Items: 0–20 |
data[].audience.global_control_exempt | boolean | No | |
data[].frequency | object | Yes | |
data[].frequency.max_impressions | integer | No | Range: 1–1000 |
data[].frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
data[].frequency.stop_after_interaction | boolean | No | |
data[].journey_only | boolean | Yes | |
data[].placement | string | null | Yes | |
data[].start_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
data[].stats | object | Yes | |
data[].stats.impressions | integer | Yes | |
data[].stats.clicks | integer | Yes | |
data[].stats.dismissals | integer | Yes | |
data[].stats.unique_users | integer | Yes | |
data[].stats.ctr | number | Yes | |
data[].variant_stats | array<object> | Yes | |
data[].variant_stats[].variant_id | string | Yes | |
data[].variant_stats[].impressions | integer | Yes | |
data[].variant_stats[].clicks | integer | Yes | |
data[].variant_stats[].ctr | number | Yes | |
data[].ab_test | object | Yes | |
data[].ab_test.winner | object | No | |
data[].ab_test.winner_variant_id | string | null | Yes | |
data[].ab_test.decided_at | string | null | Yes | |
data[].ab_test.decided_by | string | null | Yes | |
data[].variant_significance | object | 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",
"status": "draft",
"id": "iam_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {}
}
],
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
]
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"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/in-app-messages?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an in-app message (draft)
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: CreateInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 2–100 |
triggers | array<object> | Yes | Items: 1–5 |
trigger_groups | array<array<object>> | No | Items: 1–10 |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
ab_test | object | No | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | No | |
placement | string | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
}
}Responses
201 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app-messages" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true
},
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
}
}'In-app message details and statistics
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
messageId | path | string | Yes | "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Edit an in-app message
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
messageId | path | string | Yes | "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateInAppDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 2–100 |
triggers | array<object> | No | Items: 1–5 |
trigger_groups | array<array<object>> | No | Items: 1–10 |
variants | array<object> | No | Items: 0–10 |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
ab_test | object | No | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
display | object | No | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | No | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | No | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | No | |
placement | string | null | No | |
priority | integer | No | Range: 0–100 |
start_at | string (date-time) | null | No | |
end_at | string (date-time) | null | No |
Example:
{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
}
}Responses
200 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer"
}
}
],
"ab_test": {
"winner": {
"mode": "manual",
"min_impressions": 10
}
}
}'Delete an in-app message
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
messageId | path | string | Yes | "msg_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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Publish / pause / archive
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
messageId | path | string | Yes | "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: InAppStatusDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
Example:
{
"status": "draft"
}Responses
200 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/status" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "draft"
}'Pick the A/B winner manually
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
messageId | path | string | Yes | "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: InAppWinnerDto
| Field | Type | Required | Description |
|---|---|---|---|
variant_id | string | Yes | Length: 1–64 |
Example:
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: InAppMessage
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
status | enum | Yes | Values: "draft", "active", "paused", "archived" |
priority | integer | Yes | |
triggers | array<object> | Yes | |
trigger_groups | array<array<object>> | null | Yes | |
variants | array<object> | Yes | |
variants[].id | string | Yes | Length: 1–64 |
variants[].name | string | Yes | Length: 1–60 |
variants[].weight_percent | integer | Yes | Range: 1–99 |
variants[].display | object | Yes | |
variants[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
variants[].display.background_color | string | No | |
variants[].display.text_color | string | No | |
variants[].display.dismissible | boolean | No | |
variants[].display.auto_dismiss_seconds | integer | No | Range: 1–120 |
variants[].display.content_type | enum | No | Values: "blocks", "html" |
variants[].display.html | map<string, string> | No | |
variants[].display.html_height | integer | No | Range: 40–2000 |
variants[].display.blocks | array<object> | Yes | Items: 0–12 |
display | object | Yes | |
display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
display.background_color | string | No | |
display.text_color | string | No | |
display.dismissible | boolean | No | |
display.auto_dismiss_seconds | integer | No | Range: 1–120 |
display.content_type | enum | No | Values: "blocks", "html" |
display.html | map<string, string> | No | |
display.html_height | integer | No | Range: 40–2000 |
display.blocks | array<object> | Yes | Items: 0–12 |
audience | object | Yes | |
audience.included_segments | array<string> | No | Items: 0–20 |
audience.excluded_segments | array<string> | No | Items: 0–20 |
audience.global_control_exempt | boolean | No | |
frequency | object | Yes | |
frequency.max_impressions | integer | No | Range: 1–1000 |
frequency.min_interval_seconds | integer | No | Range: 0–31536000 |
frequency.stop_after_interaction | boolean | No | |
journey_only | boolean | Yes | |
placement | string | null | Yes | |
start_at | string | null | Yes | |
end_at | string | null | Yes | |
stats | object | Yes | |
stats.impressions | integer | Yes | |
stats.clicks | integer | Yes | |
stats.dismissals | integer | Yes | |
stats.unique_users | integer | Yes | |
stats.ctr | number | Yes | |
variant_stats | array<object> | Yes | |
variant_stats[].variant_id | string | Yes | |
variant_stats[].impressions | integer | Yes | |
variant_stats[].clicks | integer | Yes | |
variant_stats[].ctr | number | Yes | |
ab_test | object | Yes | |
ab_test.winner | object | No | |
ab_test.winner.mode | enum | Yes | Values: "manual", "auto" |
ab_test.winner.min_impressions | integer | No | Range: 10–1000000 |
ab_test.winner.confidence | number | No | Range: 0.8–0.99 |
ab_test.winner_variant_id | string | null | Yes | |
ab_test.decided_at | string | null | Yes | |
ab_test.decided_by | string | null | Yes | |
variant_significance | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "draft",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{
"kind": "session_start"
}
]
],
"variants": [
{
"name": "Sipariş bildirimleri",
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {
"layout": "modal",
"blocks": [
{}
],
"background_color": "değer",
"text_color": "değer"
}
}
],
"display": {
"layout": "modal",
"blocks": [
{
"url": "https://pushizo.com/orders/1001",
"type": "image",
"alt": {
"tr": "Siparişiniz yola çıktı",
"en": "Your order has shipped"
}
}
],
"background_color": "değer",
"text_color": "değer",
"dismissible": true,
"auto_dismiss_seconds": 1
},
"audience": {
"included_segments": [
"örnek"
],
"excluded_segments": [
"örnek"
],
"global_control_exempt": true
},
"frequency": {
"max_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true
},
"journey_only": true,
"placement": "örnek",
"start_at": "örnek",
"end_at": "örnek",
"stats": {
"impressions": 1,
"clicks": 1,
"dismissals": 1,
"unique_users": 1,
"ctr": 1.5
},
"variant_stats": [
{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"impressions": 1,
"clicks": 1,
"ctr": 1.5
}
],
"ab_test": {
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"decided_at": "örnek",
"decided_by": "örnek",
"winner": {
"mode": "manual",
"min_impressions": 10,
"confidence": 0.99
}
},
"variant_significance": {
"leader": "örnek",
"p_value": 149.9,
"significant": true
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'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.
Notification inbox and inbox settings
Notification inbox and inbox settings — 21 operations (GET /v1/apps/{appId}/canned-responses, POST /v1/apps/{appId}/canned-responses, PATCH /v1/apps/{appId}/canned-responses/{cannedId}, …). Generated from the OpenAPI 3.1.0 contract.