SDK endpoints (client)
SDK endpoints (client) — 51 operations (GET /sdk/v1/apps/{appId}/config, POST /sdk/v1/apps/{appId}/subscriptions, PATCH /sdk/v1/apps/{appId}/subscriptions/{subscriptionId}, …). Generated from the OpenAPI 3.1.0 contract.
Endpoints used by client SDKs. They work with proof of ownership (token_hash) instead of an API key and, when enforced, identity verification (identity_hash or JWT); called directly from the browser/device.
Base URL: https://api.pushizo.com · Tag: sdk · Interactive docs (Scalar)
Operations
Details
Public app configuration for the SDK
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SdkConfig
| Field | Type | Required | Description |
|---|---|---|---|
app_id | string | Yes | |
name | string | Yes | |
api_url | string | Yes | |
cell_id | string | null | Yes | |
identity_verification_required | boolean | Yes | |
identity_verification_mode | enum | Yes | Values: "hmac", "jwt", "both" |
platforms | object | Yes | |
platforms.ios | boolean | Yes | |
platforms.android | boolean | Yes | |
platforms.web | boolean | Yes | |
platforms.email | boolean | Yes | |
platforms.sms | boolean | Yes | |
web | object | Yes | |
web.vapid_public_key | string | null | Yes | |
web.allowed_origins | array<string> | Yes | |
web.service_worker_path | string | null | Yes | |
web.service_worker_scope | string | null | Yes | |
web.prompt | object | null | Yes | |
web.welcome_notification | object | null | Yes | |
web.click_behavior | object | null | Yes | |
web.custom_link | object | null | Yes | |
web.prompt_backoff_days | array<integer> | null | Yes | |
session | object | Yes | |
session.timeout_seconds | integer | Yes | |
in_app | object | Yes | |
in_app.min_interval_seconds | integer | Yes | |
android_channels | array<object> | Yes | |
android_channels[].id | string | Yes | |
android_channels[].name | string | Yes | |
android_channels[].description | string | null | Yes | |
android_channels[].importance | enum | Yes | Values: "low", "default", "high", "urgent" |
android_channels[].sound | string | null | Yes | |
android_channels[].vibration | boolean | Yes | |
android_channels[].group | string | null | Yes | |
categories | array<object> | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"api_url": "https://pushizo.com/orders/1001",
"cell_id": "cac_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_verification_required": true,
"identity_verification_mode": "hmac",
"platforms": {
"ios": true,
"android": true,
"web": true,
"email": true,
"sms": true
},
"web": {
"vapid_public_key": "örnek",
"allowed_origins": [
"örnek"
],
"service_worker_path": "örnek",
"service_worker_scope": "örnek",
"prompt": {
"type": "slidedown",
"enabled": true,
"collect": "push",
"delaySeconds": 1
},
"welcome_notification": {
"enabled": true,
"url": "https://pushizo.com/orders/1001",
"texts": {
"key": {
"title": "Siparişiniz yola çıktı"
}
}
},
"click_behavior": {
"match": "exact",
"action": "navigate"
},
"custom_link": {
"enabled": true,
"style": "button",
"size": "small",
"color": {
"button": "örnek"
},
"texts": {
"key": {
"subscribe": "örnek"
}
}
},
"prompt_backoff_days": [
1
]
},
"session": {
"timeout_seconds": 1
},
"in_app": {
"min_interval_seconds": 1
},
"android_channels": [
{
"name": "Sipariş bildirimleri",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"importance": "low",
"sound": "örnek",
"vibration": true,
"group": "orders"
}
],
"categories": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": 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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/config"Device/channel registration (idempotent: the same token yields a single subscription)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkRegisterDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs" |
token | string | Yes | Length: 1–4096 |
device | object | No | Default: {} |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | No | |
user | object | No | |
user.external_id | string | No | Length: 1–255 |
user.identity_hash | string | No | Length: 64–64 |
user.tags | map<string, string> | No | |
user.properties | map<string, any> | No | |
user.subscription_id | string | No | Length: 1–64 |
user.token_hash | string | No | |
ownership_proof | boolean | No |
Example:
{
"channel": "ios_push",
"token": "d1f2e3…",
"device": {},
"test_device": true,
"user": {
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"external_id": "user_42"
},
"ownership_proof": true
}Responses
200 — Success.
Schema: SdkRegisterResult
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
created | boolean | Yes |
Example response:
{
"status": "subscribed",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"created": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions" \
-H "Content-Type: application/json" \
-d '{
"channel": "ios_push",
"token": "d1f2e3…",
"device": {},
"test_device": true,
"user": {
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"external_id": "user_42"
},
"ownership_proof": true
}'Token refresh, device info, opt-in/out (proof of ownership: token_hash or identity_hash)
The proof is the SHA-256 digest of the registered token (token_hash) or the subscription user's identity_hash. For push subscriptions it is required if the subscription was registered with ownership_proof: true or has sent a valid proof once; for email/SMS subscriptions it is always required. A wrong proof returns 403 (ADR-0016).
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkSubscriptionPatchDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
token | string | No | Length: 1–4096 |
device | object | No | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
opted_in | boolean | No | |
location | object | null | No | |
advertising_id | string | null | No |
Example:
{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"opted_in": true
}Responses
200 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Content-Type: application/json" \
-d '{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"opted_in": true
}'Delete a subscription (proof of ownership: token_hash or identity_hash)
Proof rules are the same as for PATCH (ADR-0016).
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
token_hash | query | string | No | "sha256-hex…" | |
identity_hash | query | string | No | Length: 64–64 | "3f6c…b1e9" |
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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"Link the device to a user by external_id (the anonymous user is merged; proof of ownership: token_hash)
The proof of ownership is token_hash (SHA-256 digest of the registered token); identity_hash counts as proof only if the subscription is already linked to the same external_id. Rules are the same as for PATCH (ADR-0016).
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkLoginDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–255 |
identity_hash | string | No | Length: 64–64 |
token_hash | string | No |
Example:
{
"external_id": "user_42",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}Responses
200 — Success.
Schema: SdkUserResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
tags | map<string, string> | Yes |
Example response:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/login" \
-H "Content-Type: application/json" \
-d '{
"external_id": "user_42",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}'Move the device to a new anonymous user (proof of ownership: token_hash or identity_hash)
/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/logoutTry it (interactive API docs, new tab)Proof rules are the same as for PATCH (ADR-0016); the body may be empty.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (optional)
Schema: SdkLogoutDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
Example:
{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: SdkUserResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
tags | map<string, string> | Yes |
Example response:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/logout" \
-H "Content-Type: application/json" \
-d '{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}'Tag/property merge-patch (a hash is required if identity verification is enforced)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkUserPatchDto
| Field | Type | Required | Description |
|---|---|---|---|
tags | map<string, string | null> | No | |
properties | map<string, any> | No | |
deltas | object | No | |
deltas.session_count | integer | No | Range: -1000000–1000000 |
deltas.session_time | integer | No | Range: 0–31536000 |
deltas.purchases | array<object> | No | Items: 0–100 |
deltas.purchases[].sku | string | Yes | Length: 1–100 |
deltas.purchases[].amount | number | Yes | Range: 0–∞ |
deltas.purchases[].iso | string | No | Length: 3–3 |
deltas.purchases[].count | integer | No | Default: 1; Range: 1–1000 |
identity_hash | string | No | Length: 64–64 |
Example:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"deltas": {
"session_count": 1,
"session_time": 1,
"purchases": [
{
"sku": "örnek",
"amount": 149.9,
"iso": "örnek"
}
]
},
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: SdkUserResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
external_id | string | null | Yes | |
tags | map<string, string> | Yes |
Example response:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "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 PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Content-Type: application/json" \
-d '{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"deltas": {
"session_count": 1,
"session_time": 1,
"purchases": [
{
"sku": "örnek",
"amount": 149.9,
"iso": "örnek"
}
]
},
"identity_hash": "3f6c…b1e9"
}'Add an alias to the user (User.addAlias; hash required if identity verification is enforced)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkIdentityDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes | |
identity_hash | string | No | Length: 64–64 |
Example:
{
"identity": {
"external_id": [
"user_42"
]
},
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: SdkIdentityResult
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Example response:
{
"identity": {
"external_id": [
"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 PATCH "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity" \
-H "Content-Type: application/json" \
-d '{
"identity": {
"external_id": [
"user_42"
]
},
"identity_hash": "3f6c…b1e9"
}'Remove an alias from the user (User.removeAlias)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
label | path | string | Yes | "external_id" | |
identity_hash | query | string | No | Length: 64–64 | "3f6c…b1e9" |
Responses
200 — Success.
Schema: SdkIdentityResult
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Example response:
{
"identity": {
"external_id": [
"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 DELETE "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/identity/external_id"Session start (without duration) or end (with duration; proof of ownership: token_hash or identity_hash)
For the subscription_id subscription, proof rules are the same as for PATCH (ADR-0016).
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkSessionDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
subscription_id | string | Yes | Length: 1–∞ |
duration_seconds | integer | No | Range: 0–604800 |
app_version | string | null | No | |
sdk_version | string | No | Length: 0–50 |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"duration_seconds": 1,
"app_version": "örnek",
"sdk_version": "örnek"
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sessions" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"duration_seconds": 1,
"app_version": "örnek",
"sdk_version": "örnek"
}'Evaluate feature flags
Values can be read by anyone who knows the app ID. Ownership rules for subscription_id are the same as for PATCH.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkFlagsEvaluateDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
subscription_id | string | No | Length: 1–64 |
subject | string | No | Length: 1–128 |
Example:
{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subject": "Siparişiniz yola çıktı"
}Responses
200 — Success.
Schema: SdkFeatureFlags
| Field | Type | Required | Description |
|---|---|---|---|
flags | map<string, object> | Yes |
Example response:
{
"flags": {
"key": {
"enabled": true,
"value": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/feature-flags/evaluate" \
-H "Content-Type: application/json" \
-d '{
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subject": "Siparişiniz yola çıktı"
}'Nearest geofences for the device to monitor
For background geofence monitoring; geofence names are not returned.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
lat | query | number | Yes | Range: -90–90 | 1.5 |
lng | query | number | Yes | Range: -180–180 | 1.5 |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
Schema: SdkGeofenceList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].lat | number | Yes | |
data[].lng | number | Yes | |
data[].radius_m | integer | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"lat": 1.5,
"lng": 1.5,
"radius_m": 1
}
]
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/geofences?lat=1.5&lng=1.5&limit=50"Geofence transitions reported by the operating system
/sdk/v1/apps/{appId}/subscriptions/{subscriptionId}/geofence-eventsTry it (interactive API docs, new tab)Contains no coordinates. Ignored for subscriptions without location consent. Ownership rules are the same as for PATCH.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkGeofenceEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
events | array<object> | Yes | Items: 1–20 |
events[].geofence_id | string | Yes | Length: 1–64 |
events[].transition | enum | Yes | Values: "enter", "exit" |
events[].occurred_at | string (date-time) | No |
Example:
{
"events": [
{
"geofence_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"transition": "enter",
"occurred_at": "2026-10-17T09:00:00Z"
}
],
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: EventsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Example response:
{
"accepted": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/geofence-events" \
-H "Content-Type: application/json" \
-d '{
"events": [
{
"geofence_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"transition": "enter",
"occurred_at": "2026-10-17T09:00:00Z"
}
],
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}'Bulk event reporting (up to 100)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
events | array<object> | Yes | Items: 1–100 |
events[].name | string | Yes | Length: 1–100 |
events[].properties | map<string, any> | No | Default: {} |
events[].value | number | No | |
events[].occurred_at | string (date-time) | No | |
events[].event_id | string | No | Length: 8–64 |
events[].subscription_id | string | No | Length: 1–∞ |
events[].external_id | string | No | Length: 1–255 |
events[].token_hash | string | No | |
events[].identity_hash | string | No | Length: 64–64 |
Example:
{
"events": [
{
"name": "purchase",
"properties": {},
"value": 149.9,
"occurred_at": "2026-10-17T09:00:00Z"
}
]
}Responses
200 — Success.
Schema: EventsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Example response:
{
"accepted": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
-H "Content-Type: application/json" \
-d '{
"events": [
{
"name": "purchase",
"properties": {},
"value": 149.9,
"occurred_at": "2026-10-17T09:00:00Z"
}
]
}'Device received the notification (confirmed delivery)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
deliveryId | path | string | Yes | "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (optional)
Schema: ReceivedDto
| Field | Type | Required | Description |
|---|---|---|---|
received_at | string (date-time) | No | |
deprioritized | boolean | No |
Example:
{
"received_at": "2026-10-17T09:00:00Z",
"deprioritized": true
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/received" \
-H "Content-Type: application/json" \
-d '{
"received_at": "2026-10-17T09:00:00Z",
"deprioritized": true
}'Notification dismissed by the user (web notificationclose, Android swipe-away)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
deliveryId | path | string | Yes | "dlv_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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/dismissed"Notification opened / button clicked
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
deliveryId | path | string | Yes | "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: OpenedDto
| Field | Type | Required | Description |
|---|---|---|---|
button_id | string | No | Length: 0–64 |
Example:
{
"button_id": "id_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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/opened" \
-H "Content-Type: application/json" \
-d '{
"button_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Register a Live Activity token (push-to-start or activity update)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkLiveActivityTokenDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
activity_type | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "push_to_start", "update" |
activity_id | string | No | Length: 1–100 |
token | string | Yes | |
token_hash | string | No | Length: 64–64 |
identity_hash | string | No | Length: 64–64 |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_type": "order_tracking",
"kind": "push_to_start",
"token": "d1f2e3…",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: LiveActivityTokenResult
| 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_type": "order_tracking",
"kind": "push_to_start",
"token": "d1f2e3…",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}'Delete a Live Activity token (activity ended or permission revoked)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkLiveActivityTokenDeleteDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
activity_type | string | Yes | Length: 1–100 |
kind | enum | Yes | Values: "push_to_start", "update" |
activity_id | string | No | Length: 1–100 |
token_hash | string | No | Length: 64–64 |
identity_hash | string | No | Length: 64–64 |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_type": "order_tracking",
"kind": "push_to_start",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: LiveActivityTokenResult
| 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/live-activities/tokens/delete" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"activity_type": "order_tracking",
"kind": "push_to_start",
"activity_id": "act_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}'SDK error reports (up to 20; retained for 7 days)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkErrorsDto
| Field | Type | Required | Description |
|---|---|---|---|
errors | array<object> | Yes | Items: 1–20 |
errors[].level | enum | No | Values: "error", "warning"; Default: "error" |
errors[].platform | enum | Yes | Values: "web", "android", "ios", "flutter", "react_native", "node" |
errors[].sdk_version | string | No | Length: 0–50 |
errors[].code | string | No | Length: 0–100 |
errors[].message | string | Yes | Length: 1–2000 |
errors[].subscription_id | string | No | Length: 0–64 |
errors[].context | map<string, any> | No | |
errors[].occurred_at | string (date-time) | No |
Example:
{
"errors": [
{
"platform": "web",
"message": "Takip bağlantısı içeride",
"level": "error",
"sdk_version": "örnek",
"code": "örnek"
}
]
}Responses
200 — Success.
Schema: SdkErrorsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Example response:
{
"accepted": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/errors" \
-H "Content-Type: application/json" \
-d '{
"errors": [
{
"platform": "web",
"message": "Takip bağlantısı içeride",
"level": "error",
"sdk_version": "örnek",
"code": "örnek"
}
]
}'Chat widget settings (color, position, texts), online/business hours status and attachment limits
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
language | query | string | No | "tr" |
Responses
200 — Success.
Schema: SdkChatConfig
| Field | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Yes | |
online | boolean | Yes | |
within_business_hours | boolean | Yes | |
color | string | null | Yes | |
text_color | string | null | Yes | |
position | enum | Yes | Values: "right", "left" |
theme | enum | Yes | Values: "light", "dark", "auto" |
title | string | null | Yes | |
greeting | string | null | Yes | |
offline_message | string | null | Yes | |
collect_email_offline | boolean | Yes | |
require_email | boolean | Yes | |
attachments | object | Yes | |
attachments.enabled | boolean | Yes | |
attachments.max_bytes | integer | Yes | |
attachments.types | array<string> | Yes | |
language | string | Yes |
Example response:
{
"enabled": true,
"online": true,
"within_business_hours": true,
"color": "örnek",
"text_color": "örnek",
"position": "right",
"theme": "light",
"title": "Siparişiniz yola çıktı",
"greeting": "örnek",
"offline_message": "örnek",
"collect_email_offline": true,
"require_email": true,
"attachments": {
"enabled": true,
"max_bytes": 1,
"types": [
"örnek"
]
},
"language": "tr"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/config"Link the visitor to a user (external_id + identity_hash/JWT) and/or a push subscription (token_hash)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkChatIdentifyDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
external_id | string | No | Length: 1–255 |
identity_hash | string | No | Length: 16–128 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
name | string | No | Length: 1–120 |
email | string (email) | No | Length: 0–320 |
language | string | No |
Example:
{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"name": "Sipariş bildirimleri",
"external_id": "user_42",
"identity_hash": "3f6c…b1e9",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}Responses
200 — Success.
Schema: SdkChatIdentifyResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | null | Yes | |
conversation | object | null | Yes |
Example response:
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/identify" \
-H "Content-Type: application/json" \
-d '{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"name": "Sipariş bildirimleri",
"external_id": "user_42",
"identity_hash": "3f6c…b1e9",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}'The visitor's conversation and unread message count (null if none yet)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
visitor_id | query | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
token | query | string | Yes | "d1f2e3…" | |
after_seq | query | integer | No | Range: 0–∞ | 1 |
before_seq | query | integer | No | Range: 1–∞ | 1 |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
Schema: SdkChatConversation
| Field | Type | Required | Description |
|---|---|---|---|
conversation | object | null | Yes | |
unread_count | integer | Yes |
Example response:
{
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_at": "örnek"
},
"unread_count": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/conversation?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"Messages: missing ones with after_seq (oldest first), history with before_seq; sequence-numbered
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
visitor_id | query | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
token | query | string | Yes | "d1f2e3…" | |
after_seq | query | integer | No | Range: 0–∞ | 1 |
before_seq | query | integer | No | Range: 1–∞ | 1 |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
Schema: SdkChatMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].seq | integer | Yes | |
data[].client_message_id | string | null | Yes | |
data[].sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
data[].author_name | string | null | Yes | |
data[].text | string | null | Yes | |
data[].attachments | array<object> | Yes | |
data[].attachments[].id | string | Yes | |
data[].attachments[].name | string | Yes | |
data[].attachments[].type | string | Yes | |
data[].attachments[].size | integer | Yes | |
data[].quick_replies | array<object> | null | Yes | |
data[].status | enum | Yes | Values: "sent", "delivered", "read" |
data[].created_at | string | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"status": "sent",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"seq": 1,
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sender": "visitor",
"author_name": "örnek",
"text": "Takip bağlantısı içeride",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"created_at": "örnek"
}
],
"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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/messages?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"Send a message (deduplicated by client_message_id; the first message opens the conversation)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkChatSendDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
client_message_id | string | Yes | |
text | string | Yes | Length: 1–4000 |
option_id | string | No | Length: 1–64 |
name | string | No | Length: 1–120 |
email | string (email) | No | Length: 0–320 |
language | string | No | |
page_url | string | No | Length: 0–2000 |
Example:
{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": "Takip bağlantısı içeride",
"name": "Sipariş bildirimleri",
"option_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"language": "tr",
"page_url": "https://pushizo.com/orders/1001"
}Responses
200 — Success.
Schema: SdkChatSendResult
| Field | Type | Required | Description |
|---|---|---|---|
message | object | Yes | |
message.id | string | Yes | |
message.seq | integer | Yes | |
message.client_message_id | string | null | Yes | |
message.sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
message.author_name | string | null | Yes | |
message.text | string | null | Yes | |
message.attachments | array<object> | Yes | |
message.attachments[].id | string | Yes | |
message.attachments[].name | string | Yes | |
message.attachments[].type | string | Yes | |
message.attachments[].size | integer | Yes | |
message.quick_replies | array<object> | null | Yes | |
message.status | enum | Yes | Values: "sent", "delivered", "read" |
message.created_at | string | Yes | |
conversation | object | Yes | |
conversation.id | string | Yes | |
conversation.status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
conversation.last_seq | integer | Yes | |
conversation.agent_last_read_seq | integer | Yes | |
conversation.visitor_last_read_seq | integer | Yes | |
conversation.unread_count | integer | Yes | |
conversation.bot_active | boolean | Yes | |
conversation.assignee_name | string | null | Yes | |
conversation.created_at | string | Yes | |
duplicate | boolean | Yes |
Example response:
{
"message": {
"status": "sent",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"seq": 1,
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sender": "visitor",
"author_name": "örnek",
"text": "Takip bağlantısı içeride",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"created_at": "örnek"
},
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_at": "örnek"
},
"duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/messages" \
-H "Content-Type: application/json" \
-d '{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": "Takip bağlantısı içeride",
"name": "Sipariş bildirimleri",
"option_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"language": "tr",
"page_url": "https://pushizo.com/orders/1001"
}'Send a file/image attachment (multipart: file + visitor_id, visitor_token, client_message_id, text; up to 10 MB)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SdkChatSendResult
| Field | Type | Required | Description |
|---|---|---|---|
message | object | Yes | |
message.id | string | Yes | |
message.seq | integer | Yes | |
message.client_message_id | string | null | Yes | |
message.sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
message.author_name | string | null | Yes | |
message.text | string | null | Yes | |
message.attachments | array<object> | Yes | |
message.attachments[].id | string | Yes | |
message.attachments[].name | string | Yes | |
message.attachments[].type | string | Yes | |
message.attachments[].size | integer | Yes | |
message.quick_replies | array<object> | null | Yes | |
message.status | enum | Yes | Values: "sent", "delivered", "read" |
message.created_at | string | Yes | |
conversation | object | Yes | |
conversation.id | string | Yes | |
conversation.status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
conversation.last_seq | integer | Yes | |
conversation.agent_last_read_seq | integer | Yes | |
conversation.visitor_last_read_seq | integer | Yes | |
conversation.unread_count | integer | Yes | |
conversation.bot_active | boolean | Yes | |
conversation.assignee_name | string | null | Yes | |
conversation.created_at | string | Yes | |
duplicate | boolean | Yes |
Example response:
{
"message": {
"status": "sent",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"seq": 1,
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sender": "visitor",
"author_name": "örnek",
"text": "Takip bağlantısı içeride",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"created_at": "örnek"
},
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_at": "örnek"
},
"duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/attachments"Attachment file (only from this visitor's conversation; download with ?download=true)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
attachmentId | path | string | Yes | "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
visitor_id | query | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
token | query | string | Yes | "d1f2e3…" | |
after_seq | query | integer | No | Range: 0–∞ | 1 |
before_seq | query | integer | No | Range: 1–∞ | 1 |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
No body defined.
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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/attachments/cha_01JD3W5Q7X9K2M4N6P8R0T1V3W?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"Visitor typing indicator (real time to agents)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkChatTypingDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
typing | boolean | Yes |
Example:
{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"typing": true
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/typing" \
-H "Content-Type: application/json" \
-d '{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"typing": true
}'Read / delivered receipt (sequence number; only moves forward)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkChatAckDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
read_seq | integer | No | Range: 0–∞ |
delivered_seq | integer | No | Range: 0–∞ |
Example:
{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"read_seq": 1,
"delivered_seq": 1
}Responses
200 — Success.
Schema: SdkChatConversation
| Field | Type | Required | Description |
|---|---|---|---|
conversation | object | null | Yes | |
unread_count | integer | Yes |
Example response:
{
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_at": "örnek"
},
"unread_count": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/ack" \
-H "Content-Type: application/json" \
-d '{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"read_seq": 1,
"delivered_seq": 1
}'Leave a message and email when offline / outside business hours
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkChatOfflineDto
| Field | Type | Required | Description |
|---|---|---|---|
visitor_id | string | Yes | |
visitor_token | string | Yes | |
client_message_id | string | Yes | |
email | string (email) | Yes | Length: 0–320 |
name | string | No | Length: 1–120 |
text | string | Yes | Length: 1–4000 |
language | string | No |
Example:
{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"text": "Takip bağlantısı içeride",
"name": "Sipariş bildirimleri",
"language": "tr"
}Responses
200 — Success.
Schema: SdkChatSendResult
| Field | Type | Required | Description |
|---|---|---|---|
message | object | Yes | |
message.id | string | Yes | |
message.seq | integer | Yes | |
message.client_message_id | string | null | Yes | |
message.sender | enum | Yes | Values: "visitor", "agent", "bot", "system" |
message.author_name | string | null | Yes | |
message.text | string | null | Yes | |
message.attachments | array<object> | Yes | |
message.attachments[].id | string | Yes | |
message.attachments[].name | string | Yes | |
message.attachments[].type | string | Yes | |
message.attachments[].size | integer | Yes | |
message.quick_replies | array<object> | null | Yes | |
message.status | enum | Yes | Values: "sent", "delivered", "read" |
message.created_at | string | Yes | |
conversation | object | Yes | |
conversation.id | string | Yes | |
conversation.status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
conversation.last_seq | integer | Yes | |
conversation.agent_last_read_seq | integer | Yes | |
conversation.visitor_last_read_seq | integer | Yes | |
conversation.unread_count | integer | Yes | |
conversation.bot_active | boolean | Yes | |
conversation.assignee_name | string | null | Yes | |
conversation.created_at | string | Yes | |
duplicate | boolean | Yes |
Example response:
{
"message": {
"status": "sent",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"seq": 1,
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sender": "visitor",
"author_name": "örnek",
"text": "Takip bağlantısı içeride",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
],
"created_at": "örnek"
},
"conversation": {
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_seq": 1,
"agent_last_read_seq": 1,
"visitor_last_read_seq": 1,
"unread_count": 1,
"bot_active": true,
"assignee_name": "örnek",
"created_at": "örnek"
},
"duplicate": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/offline" \
-H "Content-Type: application/json" \
-d '{
"visitor_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"visitor_token": "değer",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"text": "Takip bağlantısı içeride",
"name": "Sipariş bildirimleri",
"language": "tr"
}'Live chat stream (Server-Sent Events)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
visitor_id | query | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
token | query | string | Yes | "d1f2e3…" | |
after_seq | query | integer | No | Range: 0–∞ | 1 |
before_seq | query | integer | No | Range: 1–∞ | 1 |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
No body defined.
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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/chat/stream?visitor_id=id_01JD3W5Q7X9K2M4N6P8R0T1V3W&token=d1f2e3%E2%80%A6&limit=50"In-app messages that can be shown on the device (triggers are evaluated by the SDK)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
token_hash | query | string | No | "sha256-hex…" | |
supports | query | string | No | Length: 0–200 | "değer" |
Responses
200 — Success.
Schema: SdkInAppList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].triggers | array<object> | Yes | |
data[].trigger_groups | array<array<object>> | Yes | |
data[].variant_id | string | null | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | null | Yes | |
data[].display.text_color | string | null | Yes | |
data[].display.dismissible | boolean | Yes | |
data[].display.auto_dismiss_seconds | integer | null | Yes | |
data[].display.content_type | enum | Yes | Values: "blocks", "html" |
data[].display.html | string | null | Yes | |
data[].display.html_height | integer | null | Yes | |
data[].display.blocks | array<object> | Yes | |
data[].remaining_impressions | integer | Yes | |
data[].min_interval_seconds | integer | Yes | |
data[].stop_after_interaction | boolean | Yes | |
data[].last_impression_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
language | string | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{}
]
],
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"display": {
"layout": "modal",
"background_color": "örnek",
"text_color": "örnek",
"dismissible": true,
"auto_dismiss_seconds": 1,
"content_type": "blocks",
"html": "örnek",
"html_height": 1,
"blocks": [
{}
]
},
"remaining_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true,
"last_impression_at": "örnek",
"end_at": "örnek"
}
],
"language": "tr"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"Embedded placement content
Sorted by priority; report an impression via in-app/{id}/events once the content is rendered.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
key | path | string | Yes | "key-2026-10" | |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
token_hash | query | string | No | "sha256-hex…" | |
supports | query | string | No | Length: 0–200 | "değer" |
limit | query | integer | No | Range: 1–10 | 50 |
Responses
200 — Success.
Schema: SdkInAppList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].triggers | array<object> | Yes | |
data[].trigger_groups | array<array<object>> | Yes | |
data[].variant_id | string | null | Yes | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "modal", "banner_top", "banner_bottom", "fullscreen" |
data[].display.background_color | string | null | Yes | |
data[].display.text_color | string | null | Yes | |
data[].display.dismissible | boolean | Yes | |
data[].display.auto_dismiss_seconds | integer | null | Yes | |
data[].display.content_type | enum | Yes | Values: "blocks", "html" |
data[].display.html | string | null | Yes | |
data[].display.html_height | integer | null | Yes | |
data[].display.blocks | array<object> | Yes | |
data[].remaining_impressions | integer | Yes | |
data[].min_interval_seconds | integer | Yes | |
data[].stop_after_interaction | boolean | Yes | |
data[].last_impression_at | string | null | Yes | |
data[].end_at | string | null | Yes | |
language | string | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"triggers": [
{
"kind": "session_start"
}
],
"trigger_groups": [
[
{}
]
],
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"display": {
"layout": "modal",
"background_color": "örnek",
"text_color": "örnek",
"dismissible": true,
"auto_dismiss_seconds": 1,
"content_type": "blocks",
"html": "örnek",
"html_height": 1,
"blocks": [
{}
]
},
"remaining_impressions": 1,
"min_interval_seconds": 1,
"stop_after_interaction": true,
"last_impression_at": "örnek",
"end_at": "örnek"
}
],
"language": "tr"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/placements/key-2026-10?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W&limit=50"In-app impression / click / dismiss
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
messageId | path | string | Yes | "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkInAppEventDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
token_hash | string | No | |
type | enum | Yes | Values: "impression", "click", "dismiss" |
button_id | string | No | Length: 0–64 |
variant_id | string | No | Length: 0–64 |
Example:
{
"type": "impression",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/in-app/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
-H "Content-Type: application/json" \
-d '{
"type": "impression",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Notification inbox (the subscription must belong to the user; identity_hash if required)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
identity_hash | query | string | No | Length: 0–128 | "3f6c…b1e9" |
token_hash | query | string | No | "sha256-hex…" |
Responses
200 — Success.
Schema: InboxPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | null | Yes | |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].url | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].data | map<string, string> | Yes | |
data[].read | boolean | Yes | |
data[].read_at | string | null | Yes | |
data[].archived_at | string | null | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
unread_count | integer | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"image_url": "https://pushizo.com/orders/1001",
"read": true,
"read_at": "örnek",
"archived_at": "örnek",
"expires_at": "örnek",
"created_at": "örnek"
}
],
"unread_count": 1,
"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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox?limit=50&subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"Mark all as read
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkInboxActionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
identity_hash | string | No | Length: 0–128 |
token_hash | string | No |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}Responses
200 — Success.
Schema: InboxReadAllResult
| Field | Type | Required | Description |
|---|---|---|---|
updated | integer | Yes | |
unread_count | integer | Yes |
Example response:
{
"updated": 1,
"unread_count": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/read-all" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}'Mark as read
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkInboxActionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
identity_hash | string | No | Length: 0–128 |
token_hash | string | No |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}Responses
200 — Success.
Schema: InboxItem
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
message_id | string | null | Yes | |
title | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
data | map<string, string> | Yes | |
read | boolean | Yes | |
read_at | string | null | Yes | |
archived_at | string | null | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"image_url": "https://pushizo.com/orders/1001",
"read": true,
"read_at": "örnek",
"archived_at": "örnek",
"expires_at": "örnek",
"created_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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}'Content card feed (in pinned, priority, newest order; the subscription must belong to the user)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
identity_hash | query | string | No | Length: 0–128 | "3f6c…b1e9" |
token_hash | query | string | No | "sha256-hex…" | |
limit | query | integer | No | Range: 1–100 | 50 |
Responses
200 — Success.
Schema: ContentCardList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].message_id | string | null | Yes | |
data[].type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].url | string | null | Yes | |
data[].image_url | string | null | Yes | |
data[].button_text | string | null | Yes | |
data[].data | map<string, string> | Yes | |
data[].pinned | boolean | Yes | |
data[].priority | integer | Yes | |
data[].viewed | boolean | Yes | |
data[].clicked | boolean | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
unviewed_count | integer | Yes |
Example response:
{
"data": [
{
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"type": "classic",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"image_url": "https://pushizo.com/orders/1001",
"button_text": "örnek",
"pinned": true,
"priority": 10,
"viewed": true,
"clicked": true,
"expires_at": "örnek",
"created_at": "örnek"
}
],
"unviewed_count": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/cards?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W&limit=50"Card event: impression, click or dismiss
/sdk/v1/apps/{appId}/users/{userId}/cards/{itemId}/{event}Try it (interactive API docs, new tab)Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
event | path | string | Yes | "purchase" |
Request body (required)
Schema: SdkInboxActionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | Yes | Length: 1–64 |
identity_hash | string | No | Length: 0–128 |
token_hash | string | No |
Example:
{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}Responses
200 — Success.
Schema: ContentCard
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
message_id | string | null | Yes | |
type | enum | Yes | Values: "classic", "captioned_image", "image_only" |
title | string | null | Yes | |
body | string | null | Yes | |
url | string | null | Yes | |
image_url | string | null | Yes | |
button_text | string | null | Yes | |
data | map<string, string> | Yes | |
pinned | boolean | Yes | |
priority | integer | Yes | |
viewed | boolean | Yes | |
clicked | boolean | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes |
Example response:
{
"url": "https://pushizo.com/orders/1001",
"data": {
"order_id": "1001"
},
"type": "classic",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"image_url": "https://pushizo.com/orders/1001",
"button_text": "örnek",
"pinned": true,
"priority": 10,
"viewed": true,
"clicked": true,
"expires_at": "örnek",
"created_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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/cards/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/purchase" \
-H "Content-Type: application/json" \
-d '{
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"identity_hash": "3f6c…b1e9",
"token_hash": "sha256-hex…"
}'Remove from inbox (archive)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
identity_hash | query | string | No | Length: 0–128 | "3f6c…b1e9" |
token_hash | query | string | No | "sha256-hex…" |
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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"The device user's preferences and categories
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | Yes | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
token_hash | query | string | No | "sha256-hex…" | |
identity_hash | query | string | No | Length: 64–64 | "3f6c…b1e9" |
Responses
200 — Success.
Schema: SdkPreferences
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"category": "örnek",
"opted_in": true,
"explicit": true,
"source": "örnek",
"updated_at": "örnek"
}
],
"categories": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true
}
],
"consents": [
{
"purpose": "ads_personalization",
"granted": true,
"source": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences?subscription_id=sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"Write the device user's preferences
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkSetPreferencesDto
| Field | Type | Required | Description |
|---|---|---|---|
preferences | array<object> | Yes | Items: 1–100 |
preferences[].category | string | Yes | Length: 1–64 |
preferences[].channel | enum | null | No | |
preferences[].opted_in | boolean | Yes | |
subscription_id | string | Yes | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
Example:
{
"preferences": [
{
"category": "örnek",
"opted_in": true,
"channel": "ios_push"
}
],
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}Responses
200 — Success.
Schema: SdkPreferences
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"category": "örnek",
"opted_in": true,
"explicit": true,
"source": "örnek",
"updated_at": "örnek"
}
],
"categories": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true
}
],
"consents": [
{
"purpose": "ads_personalization",
"granted": true,
"source": "ö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 PUT "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/preferences" \
-H "Content-Type: application/json" \
-d '{
"preferences": [
{
"category": "örnek",
"opted_in": true,
"channel": "ios_push"
}
],
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9"
}'Attribution touches (UTM, fbclid/gclid/ttclid…); proof of ownership same as for events
touch_id is unique (retries do not create duplicate records). landing_url is stored as origin + path only.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkAttributionDto
| Field | Type | Required | Description |
|---|---|---|---|
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
external_id | string | No | Length: 1–128 |
touches | array<object> | Yes | Items: 1–10 |
touches[].touch_id | string | Yes | Length: 8–64 |
touches[].occurred_at | string (date-time) | Yes | |
touches[].utm_source | string | No | Length: 1–200 |
touches[].utm_medium | string | No | Length: 1–200 |
touches[].utm_campaign | string | No | Length: 1–200 |
touches[].utm_term | string | No | Length: 1–200 |
touches[].utm_content | string | No | Length: 1–200 |
touches[].utm_id | string | No | Length: 1–200 |
touches[].click_id_type | enum | No | Values: "fbclid", "gclid", "gbraid", "wbraid", "ttclid", "li_fat_id", "msclkid" |
touches[].click_id | string | No | Length: 1–500 |
touches[].landing_url | string | No | Length: 0–2000 |
touches[].referrer | string | No | Length: 0–255 |
Example:
{
"touches": [
{
"touch_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"occurred_at": "2026-10-17T09:00:00Z",
"utm_source": "örnek",
"utm_medium": "örnek",
"utm_campaign": "örnek"
}
],
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"external_id": "user_42"
}Responses
200 — Success.
Schema: SdkAttributionAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Example response:
{
"accepted": 1
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/attribution" \
-H "Content-Type: application/json" \
-d '{
"touches": [
{
"touch_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"occurred_at": "2026-10-17T09:00:00Z",
"utm_source": "örnek",
"utm_medium": "örnek",
"utm_campaign": "örnek"
}
],
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"external_id": "user_42"
}'Published web campaigns (trigger/condition/frequency are evaluated in the SDK). ETag and 60 s cache: publishing changes are reflected within 1 minute at most.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | No | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
token_hash | query | string | No | "sha256-hex…" | |
language | query | string | No | Length: 2–10 | "tr" |
Responses
200 — Success.
Schema: SdkWebCampaignList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].trigger | object | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.visitor | enum | Yes | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | Yes | |
data[].frequency | object | Yes | |
data[].frequency.max_per_session | integer | No | Range: 1–100 |
data[].frequency.max_per_day | integer | No | Range: 1–100 |
data[].frequency.max_total | integer | No | Range: 1–1000 |
data[].frequency.hide_after_close_days | integer | No | Range: 0–365 |
data[].frequency.stop_after_conversion | boolean | No | |
data[].display | object | Yes | |
data[].display.layout | enum | Yes | Values: "popup", "banner_top", "banner_bottom", "slide_in", "fullscreen" |
data[].display.position | enum | Yes | Values: "left", "right" |
data[].display.background_color | string | null | Yes | |
data[].display.text_color | string | null | Yes | |
data[].display.dismissible | boolean | Yes | |
data[].display.auto_dismiss_seconds | integer | null | Yes | |
data[].display.max_width | integer | null | Yes | |
data[].display.blocks | array<object> | Yes | |
data[].display.form_id | string | null | Yes | |
data[].display.survey_id | string | null | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].display | object | Yes | |
data[].end_at | string | null | Yes | |
forms | map<string, object> | Yes | |
surveys | map<string, object> | Yes | |
language | string | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"trigger": {
"kind": "page_load",
"delay_seconds": 1
},
"conditions": {
"url_rules": [
{}
],
"utm_rules": [
{}
]
},
"targeting": {
"visitor": "all",
"devices": [
"desktop"
]
},
"frequency": {
"max_per_session": 1,
"max_per_day": 1
},
"display": {
"layout": "popup",
"position": "left",
"background_color": "örnek",
"text_color": "örnek",
"dismissible": true,
"auto_dismiss_seconds": 1,
"max_width": 1,
"blocks": [
{}
],
"form_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"survey_id": "srv_01JD3W5Q7X9K2M4N6P8R0T1V3W"
},
"variants": [
{
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"display": {}
}
],
"end_at": "örnek"
}
],
"forms": {
"key": {
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"fields": [
{
"type": "email",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id",
"placeholder": "örnek",
"required": true,
"options": [],
"max_length": 1,
"policy_url": "https://pushizo.com/orders/1001"
}
],
"submit_label": "örnek",
"success_message": "örnek"
}
},
"surveys": {
"key": {
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"questions": [
{
"type": "nps",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"text": "Takip bağlantısı içeride",
"required": true,
"options": [],
"low_label": "örnek",
"high_label": "örnek",
"placeholder": "örnek"
}
],
"submit_label": "örnek",
"thank_you": "örnek"
}
},
"language": "tr"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns"Web campaign impression / click / dismiss / conversion
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
campaignId | path | string | Yes | "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkWebCampaignEventDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "impression", "click", "close", "conversion" |
visitor_id | string | Yes | |
variant_id | string | No | Length: 0–64 |
button_id | string | No | Length: 0–64 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No |
Example:
{
"type": "impression",
"visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-campaigns/cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
-H "Content-Type: application/json" \
-d '{
"type": "impression",
"visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"button_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}'Form submission: creates or links a user/subscription, records consent, emits a journey event
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
formId | path | string | Yes | "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkFormSubmitDto
| Field | Type | Required | Description |
|---|---|---|---|
values | map<string, string | boolean | number | array<string>> | Yes | |
visitor_id | string | No | |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
identity_hash | string | No | Length: 64–64 |
web_campaign_id | string | No | Length: 0–64 |
page_url | string | No | Length: 0–2000 |
language | string | No | Length: 2–10 |
website | string | No | Length: 0–500 |
elapsed_ms | integer | No | Range: 0–86400000 |
Example:
{
"values": {
"key": "user_42"
},
"visitor_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: FormSubmitResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
status | enum | Yes | Values: "accepted", "pending_confirmation" |
submission_id | string | null | Yes | |
success_message | string | Yes | |
redirect_url | string | null | Yes |
Example response:
{
"status": "accepted",
"ok": true,
"submission_id": "fsb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"success_message": "örnek",
"redirect_url": "https://pushizo.com/orders/1001"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/forms/frm_01JD3W5Q7X9K2M4N6P8R0T1V3W/submissions" \
-H "Content-Type: application/json" \
-d '{
"values": {
"key": "user_42"
},
"visitor_id": "frm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"identity_hash": "3f6c…b1e9",
"web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Survey response (web pop-up or native in-app UI)
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
surveyId | path | string | Yes | "srv_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkSurveyResponseDto
| Field | Type | Required | Description |
|---|---|---|---|
answers | map<string, string | boolean | number | array<string>> | Yes | |
visitor_id | string | No | |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No | |
web_campaign_id | string | No | Length: 0–64 |
Example:
{
"answers": {
"key": "user_42"
},
"visitor_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: SurveyResponseResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes | |
response_id | string | null | Yes | |
duplicate | boolean | Yes | |
thank_you | string | Yes |
Example response:
{
"ok": true,
"response_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"duplicate": true,
"thank_you": "ö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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/surveys/srv_01JD3W5Q7X9K2M4N6P8R0T1V3W/responses" \
-H "Content-Type: application/json" \
-d '{
"answers": {
"key": "user_42"
},
"visitor_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…",
"web_campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Published personalization experiences (conditions/variants are evaluated in the SDK). ETag and 60 s cache.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
subscription_id | query | string | No | Length: 1–64 | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
token_hash | query | string | No | "sha256-hex…" | |
language | query | string | No | Length: 2–10 | "tr" |
Responses
200 — Success.
Schema: SdkWebPersonalizationList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].priority | integer | Yes | |
data[].conditions | object | Yes | |
data[].conditions.url_rules | array<object> | No | Items: 0–10 |
data[].conditions.utm_rules | array<object> | No | Items: 0–5 |
data[].conditions.visits | object | No | |
data[].targeting | object | Yes | |
data[].targeting.visitor | enum | Yes | Values: "all", "new", "returning" |
data[].targeting.devices | array<enum> | Yes | |
data[].changes | array<object> | Yes | |
data[].changes[].selector | string | Yes | |
data[].changes[].action | enum | Yes | Values: "text", "image", "link", "hide", "show" |
data[].changes[].text | string | null | Yes | |
data[].changes[].url | string | null | Yes | |
data[].changes[].alt | string | null | Yes | |
data[].changes[].new_tab | boolean | Yes | |
data[].variants | array<object> | Yes | |
data[].variants[].id | string | Yes | |
data[].variants[].weight_percent | integer | Yes | |
data[].variants[].changes | array<object> | Yes | |
data[].winner_variant_id | string | null | Yes | |
data[].goal | object | null | Yes | |
data[].end_at | string | null | Yes | |
editor_origins | array<string> | Yes | |
language | string | Yes |
Example response:
{
"data": [
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"priority": 10,
"conditions": {
"url_rules": [
{}
],
"utm_rules": [
{}
]
},
"targeting": {
"visitor": "all",
"devices": [
"desktop"
]
},
"changes": [
{
"url": "https://pushizo.com/orders/1001",
"selector": "örnek",
"action": "text",
"text": "Takip bağlantısı içeride",
"alt": "örnek",
"new_tab": true
}
],
"variants": [
{
"id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"weight_percent": 1,
"changes": []
}
],
"winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"goal": {
"type": "event",
"event": "purchase"
},
"end_at": "örnek"
}
],
"editor_origins": [
"örnek"
],
"language": "tr"
}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/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations"Personalization exposure / conversion event
/sdk/v1/apps/{appId}/web-personalizations/{personalizationId}/eventsTry it (interactive API docs, new tab)Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
personalizationId | path | string | Yes | "wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SdkWebPersonalizationEventDto
| Field | Type | Required | Description |
|---|---|---|---|
type | enum | Yes | Values: "impression", "conversion" |
visitor_id | string | Yes | |
variant_id | string | No | Length: 0–64 |
subscription_id | string | No | Length: 1–64 |
token_hash | string | No |
Example:
{
"type": "impression",
"visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/web-personalizations/wpz_01JD3W5Q7X9K2M4N6P8R0T1V3W/events" \
-H "Content-Type: application/json" \
-d '{
"type": "impression",
"visitor_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_hash": "sha256-hex…"
}'Site search: results and (with mode=answer) an AI answer with sources from the site's own content. If an AI answer cannot be given, only results are returned.
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SiteSearchRequestDto
| Field | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Length: 0–1000 |
mode | enum | No | Values: "search", "answer" |
language | string | No | |
limit | integer | No | Range: 1–20 |
Example:
{
"query": "ayse",
"mode": "search",
"language": "tr",
"limit": 50
}Responses
200 — Success.
Schema: SiteSearchResponse
| Field | Type | Required | Description |
|---|---|---|---|
query_id | string | Yes | |
mode | enum | Yes | Values: "search", "answer" |
results | array<object> | Yes | |
results[].id | string | Yes | |
results[].url | string | Yes | |
results[].title | string | Yes | |
results[].heading | string | Yes | |
results[].snippet | string | Yes | |
results[].snippet_html | string | Yes | |
answer | object | null | Yes | |
answer_status | enum | null | Yes | |
answers_available | boolean | Yes |
Example response:
{
"query_id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"mode": "search",
"results": [
{
"url": "https://pushizo.com/orders/1001",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı",
"heading": "Siparişiniz yola çıktı",
"snippet": "örnek",
"snippet_html": "örnek"
}
],
"answer": {
"text": "Takip bağlantısı içeride",
"sources": [
{
"url": "https://pushizo.com/orders/1001",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı"
}
]
},
"answer_status": "answered",
"answers_available": 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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/search" \
-H "Content-Type: application/json" \
-d '{
"query": "ayse",
"mode": "search",
"language": "tr",
"limit": 50
}'Search event: clicked result
Authentication: no API key; proof of ownership (token_hash) and, when required, identity verification (identity_hash or JWT). Details: SDK identity.
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SiteSearchEventDto
| Field | Type | Required | Description |
|---|---|---|---|
query_id | string | Yes | Length: 0–60 |
type | enum | Yes | Values: "click" |
url | string | Yes | Length: 0–2000 |
position | integer | No | Range: 1–100 |
Example:
{
"url": "https://pushizo.com/orders/1001",
"type": "click",
"query_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"position": 1
}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 POST "https://api.pushizo.com/sdk/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/search/events" \
-H "Content-Type: application/json" \
-d '{
"url": "https://pushizo.com/orders/1001",
"type": "click",
"query_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"position": 1
}'MCP drafts
MCP drafts — 11 operations (POST /v1/mcp/apps, POST /v1/apps/{appId}/mcp/campaign-drafts, POST /v1/apps/{appId}/mcp/segment-drafts, …). Generated from the OpenAPI 3.1.0 contract.
feature-flags
feature-flags — 6 operations (GET /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags, POST /v1/apps/{appId}/feature-flags/evaluate, …). Generated from the OpenAPI 3.1.0 contract.