Conversations (live chat, WhatsApp, SMS, email)
Conversations (live chat, WhatsApp, SMS, email) — 24 operations (GET /v1/apps/{appId}/ai-agents, POST /v1/apps/{appId}/ai-agents, GET /v1/apps/{appId}/ai-agents/runs, …). Generated from the OpenAPI 3.1.0 contract.
Unified inbox conversations (live chat, WhatsApp, SMS, RCS, email replies): list, messages, reply, assignment, status, read receipts and tags; WhatsApp templates and keyword automations.
Base URL: https://api.pushizo.com · Tag: conversations · Interactive docs (Scalar)
Operations
Details
AI agents
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AiAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].enabled | boolean | Yes | |
data[].channels | array<enum> | Yes | |
data[].instructions | string | Yes | |
data[].faq | array<object> | Yes | |
data[].faq[].question | string | Yes | |
data[].faq[].answer | string | Yes | |
data[].tools | array<object> | Yes | |
data[].tools[].name | string | Yes | |
data[].tools[].description | string | Yes | |
data[].tools[].url | string | Yes | |
data[].tools[].params | array<object> | Yes | |
data[].handoff | object | Yes | |
data[].handoff.keywords | array<string> | Yes | |
data[].handoff.max_bot_replies | integer | Yes | |
data[].handoff.on_negative_sentiment | boolean | Yes | |
data[].handoff.message | string | Yes | |
data[].limits | object | Yes | |
data[].limits.monthly_token_cap | integer | Yes | |
data[].limits.max_steps | integer | Yes | |
data[].ai_sentiment | boolean | Yes | |
data[].has_tool_secret | boolean | Yes | |
data[].usage | object | Yes | |
data[].usage.tokens_this_month | integer | Yes | |
data[].usage.period_start | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": []
}
],
"handoff": {
"keywords": [
"örnek"
],
"max_bot_replies": 1,
"on_negative_sentiment": true,
"message": "Takip bağlantısı içeride"
},
"limits": {
"monthly_token_cap": 1,
"max_steps": 1
},
"ai_sentiment": true,
"has_tool_secret": true,
"usage": {
"tokens_this_month": 1,
"period_start": "örnek"
},
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an AI agent
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateAiAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
channels | array<enum> | No | Items: 0–6 |
instructions | string | No | Length: 0–4000 |
faq | array<object> | No | Items: 0–50 |
faq[].question | string | Yes | Length: 1–300 |
faq[].answer | string | Yes | Length: 1–1500 |
tools | array<object> | No | Items: 0–10 |
tools[].name | string | Yes | |
tools[].description | string | Yes | Length: 1–500 |
tools[].url | string (uri) | Yes | Length: 0–2000 |
tools[].params | array<object> | No | Items: 0–8 |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | No | Length: 0–200 |
tools[].params[].required | boolean | No | |
handoff | object | No | |
handoff.keywords | array<string> | No | Items: 0–20 |
handoff.max_bot_replies | integer | No | Range: 1–50 |
handoff.on_negative_sentiment | boolean | No | |
handoff.message | string | No | Length: 0–500 |
limits | object | No | |
limits.monthly_token_cap | integer | No | Range: 1000–50000000 |
limits.max_steps | integer | No | Range: 1–6 |
ai_sentiment | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri"
}
]
}
]
}Responses
201 — Success.
Schema: AiAgentWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
tool_secret | string | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"required": true
}
]
}
],
"handoff": {
"keywords": [
"örnek"
],
"max_bot_replies": 1,
"on_negative_sentiment": true,
"message": "Takip bağlantısı içeride"
},
"limits": {
"monthly_token_cap": 1,
"max_steps": 1
},
"ai_sentiment": true,
"has_tool_secret": true,
"usage": {
"tokens_this_month": 1,
"period_start": "örnek"
},
"created_at": "örnek",
"updated_at": "örnek",
"tool_secret": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri"
}
]
}
]
}'AI agent runs
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agent_id | query | string | No | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
conversation_id | query | string | No | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
status | query | enum | No | Values: "pending", "replied", "handed_off", "skipped_cap", "failed" | "pending" |
limit | query | integer | No | Range: 1–100 | 50 |
cursor | query | string | No | "eyJpZCI6Im1zZ18wMUpE…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AiAgentRunList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].agent_id | string | Yes | |
data[].conversation_id | string | Yes | |
data[].status | enum | Yes | Values: "pending", "replied", "handed_off", "skipped_cap", "failed" |
data[].steps | array<object> | Yes | |
data[].steps[].kind | enum | Yes | Values: "reply", "tool", "handoff" |
data[].steps[].tool | string | No | |
data[].steps[].status | integer | null | No | |
data[].steps[].ok | boolean | No | |
data[].steps[].duration_ms | integer | No | |
data[].input_tokens | integer | Yes | |
data[].output_tokens | integer | Yes | |
data[].handoff_reason | string | null | Yes | |
data[].error | string | null | Yes | |
data[].created_at | string | Yes | |
data[].finished_at | string | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"status": "pending",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"agent_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"conversation_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"steps": [
{
"kind": "reply",
"status": 1,
"tool": "örnek"
}
],
"input_tokens": 1,
"output_tokens": 1,
"handoff_reason": "örnek",
"error": "örnek",
"created_at": "örnek",
"finished_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/runs?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"AI agent
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AiAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"required": true
}
]
}
],
"handoff": {
"keywords": [
"örnek"
],
"max_bot_replies": 1,
"on_negative_sentiment": true,
"message": "Takip bağlantısı içeride"
},
"limits": {
"monthly_token_cap": 1,
"max_steps": 1
},
"ai_sentiment": true,
"has_tool_secret": true,
"usage": {
"tokens_this_month": 1,
"period_start": "örnek"
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update an AI agent
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateAiAgentDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
channels | array<enum> | No | Items: 0–6 |
instructions | string | No | Length: 0–4000 |
faq | array<object> | No | Items: 0–50 |
faq[].question | string | Yes | Length: 1–300 |
faq[].answer | string | Yes | Length: 1–1500 |
tools | array<object> | No | Items: 0–10 |
tools[].name | string | Yes | |
tools[].description | string | Yes | Length: 1–500 |
tools[].url | string (uri) | Yes | Length: 0–2000 |
tools[].params | array<object> | No | Items: 0–8 |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | No | Length: 0–200 |
tools[].params[].required | boolean | No | |
handoff | object | No | |
handoff.keywords | array<string> | No | Items: 0–20 |
handoff.max_bot_replies | integer | No | Range: 1–50 |
handoff.on_negative_sentiment | boolean | No | |
handoff.message | string | No | Length: 0–500 |
limits | object | No | |
limits.monthly_token_cap | integer | No | Range: 1000–50000000 |
limits.max_steps | integer | No | Range: 1–6 |
ai_sentiment | boolean | No |
Example:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
]
}Responses
200 — Success.
Schema: AiAgent
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"required": true
}
]
}
],
"handoff": {
"keywords": [
"örnek"
],
"max_bot_replies": 1,
"on_negative_sentiment": true,
"message": "Takip bağlantısı içeride"
},
"limits": {
"monthly_token_cap": 1,
"max_steps": 1
},
"ai_sentiment": true,
"has_tool_secret": true,
"usage": {
"tokens_this_month": 1,
"period_start": "örnek"
},
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
]
}'Delete an AI agent
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
204 — Success.
No body.
Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Rotate the tool signing secret
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AiAgentWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
channels | array<enum> | Yes | |
instructions | string | Yes | |
faq | array<object> | Yes | |
faq[].question | string | Yes | |
faq[].answer | string | Yes | |
tools | array<object> | Yes | |
tools[].name | string | Yes | |
tools[].description | string | Yes | |
tools[].url | string | Yes | |
tools[].params | array<object> | Yes | |
tools[].params[].name | string | Yes | |
tools[].params[].description | string | Yes | |
tools[].params[].required | boolean | Yes | |
handoff | object | Yes | |
handoff.keywords | array<string> | Yes | |
handoff.max_bot_replies | integer | Yes | |
handoff.on_negative_sentiment | boolean | Yes | |
handoff.message | string | Yes | |
limits | object | Yes | |
limits.monthly_token_cap | integer | Yes | |
limits.max_steps | integer | Yes | |
ai_sentiment | boolean | Yes | |
has_tool_secret | boolean | Yes | |
usage | object | Yes | |
usage.tokens_this_month | integer | Yes | |
usage.period_start | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
tool_secret | string | null | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"channels": [
"whatsapp"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"instructions": "örnek",
"faq": [
{
"question": "örnek",
"answer": "örnek"
}
],
"tools": [
{
"name": "Sipariş bildirimleri",
"url": "https://pushizo.com/orders/1001",
"description": "Sipariş durumu güncellemeleri",
"params": [
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"required": true
}
]
}
],
"handoff": {
"keywords": [
"örnek"
],
"max_bot_replies": 1,
"on_negative_sentiment": true,
"message": "Takip bağlantısı içeride"
},
"limits": {
"monthly_token_cap": 1,
"max_steps": 1
},
"ai_sentiment": true,
"has_tool_secret": true,
"usage": {
"tokens_this_month": 1,
"period_start": "örnek"
},
"created_at": "örnek",
"updated_at": "örnek",
"tool_secret": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/rotate-secret" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"AI agent metrics (last 30 days)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
agentId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: AiAgentMetrics
| Field | Type | Required | Description |
|---|---|---|---|
period_days | integer | Yes | |
runs | integer | Yes | |
replied | integer | Yes | |
handed_off | integer | Yes | |
skipped_cap | integer | Yes | |
failed | integer | Yes | |
conversations | integer | Yes | |
resolution_rate | number | Yes | |
avg_steps | number | Yes | |
tool_calls | integer | Yes | |
tool_error_rate | number | Yes | |
tokens | integer | Yes | |
handoff_reasons | map<string, integer> | Yes |
Example response:
{
"period_days": 1,
"runs": 1,
"replied": 1,
"handed_off": 1,
"skipped_cap": 1,
"failed": 1,
"conversations": 1,
"resolution_rate": 1.5,
"avg_steps": 1.5,
"tool_calls": 1,
"tool_error_rate": 1.5,
"tokens": 1,
"handoff_reasons": {
"key": 150
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/ai-agents/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/metrics" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversations (SMS, WhatsApp, RCS, email, live chat; ordered by last message; channel/status/unread/assignee/team/contact filters)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
channel | query | enum | No | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" | "sms" |
status | query | enum | No | Values: "open", "pending", "resolved", "closed" | "open" |
unread | query | enum | No | Values: "true", "false" | "true" |
q | query | string | No | Length: 2–255 | "ayse" |
assignee | query | string | No | Length: 2–64 | "örnek" |
team_id | query | string | No | Length: 1–64 | "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ConversationPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
data[].status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
data[].subscription_id | string | null | Yes | |
data[].subscription_status | string | null | Yes | |
data[].user_id | string | null | Yes | |
data[].external_id | string | null | Yes | |
data[].contact | string | Yes | |
data[].opted_in | boolean | Yes | |
data[].last_message_at | string | Yes | |
data[].last_inbound_at | string | null | Yes | |
data[].last_direction | enum | null | Yes | |
data[].last_message_preview | string | null | Yes | |
data[].unread_count | integer | Yes | |
data[].window | object | null | Yes | |
data[].created_at | string | Yes | |
data[].assignee_id | string | null | Yes | |
data[].team_id | string | null | Yes | |
data[].assigned_at | string | null | Yes | |
data[].language | string | null | Yes | |
data[].bot_active | boolean | Yes | |
data[].last_seq | integer | Yes | |
data[].visitor_last_read_seq | integer | Yes | |
data[].visitor_last_delivered_seq | integer | Yes | |
data[].agent_last_read_seq | integer | Yes | |
data[].waiting_since | string | null | Yes | |
data[].first_response_at | string | null | Yes | |
data[].sla_due_at | string | null | Yes | |
data[].resolved_at | string | null | Yes | |
data[].visitor | object | null | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_status": "örnek",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"contact": "örnek",
"opted_in": true,
"last_message_at": "örnek",
"last_inbound_at": "örnek",
"last_direction": "inbound",
"last_message_preview": "örnek",
"unread_count": 1,
"window": {
"open": true,
"expires_at": "örnek"
},
"created_at": "örnek",
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek",
"language": "tr",
"bot_active": true,
"last_seq": 1,
"visitor_last_read_seq": 1,
"visitor_last_delivered_seq": 1,
"agent_last_read_seq": 1,
"waiting_since": "örnek",
"first_response_at": "örnek",
"sla_due_at": "örnek",
"resolved_at": "örnek",
"visitor": {
"name": "Sipariş bildirimleri",
"email": "ayse@pushizo.com"
}
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversation (including assignment, SLA, bot status, WhatsApp session window and opt-in)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Conversation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
subscription_id | string | null | Yes | |
subscription_status | string | null | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
contact | string | Yes | |
opted_in | boolean | Yes | |
last_message_at | string | Yes | |
last_inbound_at | string | null | Yes | |
last_direction | enum | null | Yes | |
last_message_preview | string | null | Yes | |
unread_count | integer | Yes | |
window | object | null | Yes | |
created_at | string | Yes | |
assignee_id | string | null | Yes | |
team_id | string | null | Yes | |
assigned_at | string | null | Yes | |
language | string | null | Yes | |
bot_active | boolean | Yes | |
last_seq | integer | Yes | |
visitor_last_read_seq | integer | Yes | |
visitor_last_delivered_seq | integer | Yes | |
agent_last_read_seq | integer | Yes | |
waiting_since | string | null | Yes | |
first_response_at | string | null | Yes | |
sla_due_at | string | null | Yes | |
resolved_at | string | null | Yes | |
visitor | object | null | Yes |
Example response:
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_status": "örnek",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"contact": "örnek",
"opted_in": true,
"last_message_at": "örnek",
"last_inbound_at": "örnek",
"last_direction": "inbound",
"last_message_preview": "örnek",
"unread_count": 1,
"window": {
"open": true,
"expires_at": "örnek"
},
"created_at": "örnek",
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek",
"language": "tr",
"bot_active": true,
"last_seq": 1,
"visitor_last_read_seq": 1,
"visitor_last_delivered_seq": 1,
"agent_last_read_seq": 1,
"waiting_since": "örnek",
"first_response_at": "örnek",
"sla_due_at": "örnek",
"resolved_at": "örnek",
"visitor": {
"name": "Sipariş bildirimleri",
"email": "ayse@pushizo.com"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversation status: open / pending / resolved (closed = resolved)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ConversationUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
Example:
{
"status": "open"
}Responses
200 — Success.
Schema: Conversation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
subscription_id | string | null | Yes | |
subscription_status | string | null | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
contact | string | Yes | |
opted_in | boolean | Yes | |
last_message_at | string | Yes | |
last_inbound_at | string | null | Yes | |
last_direction | enum | null | Yes | |
last_message_preview | string | null | Yes | |
unread_count | integer | Yes | |
window | object | null | Yes | |
created_at | string | Yes | |
assignee_id | string | null | Yes | |
team_id | string | null | Yes | |
assigned_at | string | null | Yes | |
language | string | null | Yes | |
bot_active | boolean | Yes | |
last_seq | integer | Yes | |
visitor_last_read_seq | integer | Yes | |
visitor_last_delivered_seq | integer | Yes | |
agent_last_read_seq | integer | Yes | |
waiting_since | string | null | Yes | |
first_response_at | string | null | Yes | |
sla_due_at | string | null | Yes | |
resolved_at | string | null | Yes | |
visitor | object | null | Yes |
Example response:
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_status": "örnek",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"contact": "örnek",
"opted_in": true,
"last_message_at": "örnek",
"last_inbound_at": "örnek",
"last_direction": "inbound",
"last_message_preview": "örnek",
"unread_count": 1,
"window": {
"open": true,
"expires_at": "örnek"
},
"created_at": "örnek",
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek",
"language": "tr",
"bot_active": true,
"last_seq": 1,
"visitor_last_read_seq": 1,
"visitor_last_delivered_seq": 1,
"agent_last_read_seq": 1,
"waiting_since": "örnek",
"first_response_at": "örnek",
"sla_due_at": "örnek",
"resolved_at": "örnek",
"visitor": {
"name": "Sipariş bildirimleri",
"email": "ayse@pushizo.com"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "open"
}'Contact profile: properties, tags, subscriptions (masked), recent events and other conversations
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ConversationContact
| Field | Type | Required | Description |
|---|---|---|---|
user | object | null | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].channel | string | Yes | |
subscriptions[].status | string | Yes | |
subscriptions[].token_masked | string | null | Yes | |
subscriptions[].created_at | string | Yes | |
recent_events | array<object> | Yes | |
recent_events[].name | string | Yes | |
recent_events[].occurred_at | string | Yes | |
recent_events[].properties | map<string, any> | Yes | |
other_conversations | array<object> | Yes | |
other_conversations[].id | string | Yes | |
other_conversations[].channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
other_conversations[].status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
other_conversations[].last_message_at | string | Yes |
Example response:
{
"subscriptions": [
{
"channel": "web_push",
"status": "örnek",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token_masked": "örnek",
"created_at": "örnek"
}
],
"user": {
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"language": "tr",
"timezone": "Europe/Istanbul",
"country": "TR",
"created_at": "örnek",
"last_seen_at": "örnek"
},
"recent_events": [
{
"name": "purchase",
"properties": {
"order_id": "1001"
},
"occurred_at": "örnek"
}
],
"other_conversations": [
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"last_message_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/contact" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Conversation messages (newest first; oldest first with after_seq; outbound message status comes from the delivery or the read receipt)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
after_seq | query | integer | No | Range: 0–∞ | 1 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ConversationMessagePage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].direction | enum | Yes | Values: "inbound", "outbound" |
data[].status | string | Yes | |
data[].body | string | null | Yes | |
data[].content | map<string, any> | Yes | |
data[].message_id | string | null | Yes | |
data[].delivery_id | string | null | Yes | |
data[].sent_by | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].read_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].seq | integer | Yes | |
data[].sender_type | string | Yes | |
data[].client_message_id | 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 | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"status": "örnek",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"direction": "inbound",
"body": "Takip bağlantısı içeride",
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sent_by": "örnek",
"error_code": "örnek",
"read_at": "örnek",
"created_at": "örnek",
"seq": 1,
"sender_type": "örnek",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
]
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/messages?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Send a reply (deduplicated by client_message_id). Chat: direct; email: transactional email with a reply-to address; WhatsApp: opt-in required, text/media within 24 hours of the last inbound message, only approved templates outside the window (otherwise 422 WHATSAPP_WINDOW_CLOSED).
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ConversationReplyDto
| Field | Type | Required | Description |
|---|---|---|---|
text | string | No | Length: 1–4096 |
template | object | No | |
template.name | string | Yes | |
template.language | string | Yes | |
template.header | object | No | |
template.body_params | array<string> | No | Items: 0–20 |
template.button_params | array<object> | No | Items: 0–10 |
template.button_params[].index | integer | Yes | Range: 0–9 |
template.button_params[].sub_type | enum | Yes | Values: "url", "quick_reply", "copy_code" |
template.button_params[].value | string | Yes | Length: 1–256 |
media | object | No | |
media.type | enum | Yes | Values: "image", "video", "document", "audio" |
media.url | string (url) | Yes | Length: 0–2000 |
media.filename | string | No | Length: 1–240 |
interactive | object | No | |
interactive.type | enum | Yes | Values: "button", "list" |
interactive.header | string | No | Length: 1–60 |
interactive.footer | string | No | Length: 1–60 |
interactive.buttons | array<object> | No | Items: 1–3 |
interactive.buttons[].id | string | Yes | Length: 1–256 |
interactive.buttons[].title | string | Yes | Length: 1–20 |
interactive.list | object | No | |
interactive.list.button | string | Yes | Length: 1–20 |
interactive.list.sections | array<object> | Yes | Items: 1–10 |
interactive.list.sections[].title | string | No | Length: 1–24 |
interactive.list.sections[].rows | array<object> | Yes | Items: 1–10 |
interactive.list.sections[].rows[].id | string | Yes | Length: 1–200 |
interactive.list.sections[].rows[].title | string | Yes | Length: 1–24 |
interactive.list.sections[].rows[].description | string | No | Length: 1–72 |
client_message_id | string | No | |
source | enum | No | Values: "manual", "canned", "ai_suggestion" |
Example:
{
"text": "Takip bağlantısı içeride",
"template": {
"name": "Sipariş bildirimleri",
"language": "tr",
"header": {
"type": "text",
"text": "Takip bağlantısı içeride"
},
"body_params": [
"örnek"
],
"button_params": [
{
"index": 1,
"sub_type": "url",
"value": "user_42"
}
]
},
"media": {
"url": "https://pushizo.com/orders/1001",
"type": "image",
"filename": "örnek"
},
"interactive": {
"type": "button",
"header": "örnek",
"footer": "örnek",
"buttons": [
{
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı"
}
]
},
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
202 — Success.
Schema: ConversationReplyResult
| Field | Type | Required | Description |
|---|---|---|---|
message_id | string | null | Yes | |
conversation_message | object | Yes | |
conversation_message.id | string | Yes | |
conversation_message.direction | enum | Yes | Values: "inbound", "outbound" |
conversation_message.status | string | Yes | |
conversation_message.body | string | null | Yes | |
conversation_message.content | map<string, any> | Yes | |
conversation_message.message_id | string | null | Yes | |
conversation_message.delivery_id | string | null | Yes | |
conversation_message.sent_by | string | null | Yes | |
conversation_message.error_code | string | null | Yes | |
conversation_message.read_at | string | null | Yes | |
conversation_message.created_at | string | Yes | |
conversation_message.seq | integer | Yes | |
conversation_message.sender_type | string | Yes | |
conversation_message.client_message_id | string | null | Yes | |
conversation_message.attachments | array<object> | Yes | |
conversation_message.attachments[].id | string | Yes | |
conversation_message.attachments[].name | string | Yes | |
conversation_message.attachments[].type | string | Yes | |
conversation_message.attachments[].size | integer | Yes | |
conversation_message.quick_replies | array<object> | null | Yes |
Example response:
{
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"conversation_message": {
"status": "örnek",
"id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"direction": "inbound",
"body": "Takip bağlantısı içeride",
"content": {
"contents": {
"tr": "Siparişiniz yola çıktı"
}
},
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sent_by": "örnek",
"error_code": "örnek",
"read_at": "örnek",
"created_at": "örnek",
"seq": 1,
"sender_type": "örnek",
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"attachments": [
{
"name": "Sipariş bildirimleri",
"type": "örnek",
"id": "cha_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"size": 1
}
],
"quick_replies": [
{
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"label": "external_id"
}
]
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/messages" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "Takip bağlantısı içeride",
"template": {
"name": "Sipariş bildirimleri",
"language": "tr",
"header": {
"type": "text",
"text": "Takip bağlantısı içeride"
},
"body_params": [
"örnek"
],
"button_params": [
{
"index": 1,
"sub_type": "url",
"value": "user_42"
}
]
},
"media": {
"url": "https://pushizo.com/orders/1001",
"type": "image",
"filename": "örnek"
},
"interactive": {
"type": "button",
"header": "örnek",
"footer": "örnek",
"buttons": [
{
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"title": "Siparişiniz yola çıktı"
}
]
},
"client_message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Mark inbound messages as read (in chat, a read receipt is sent to the visitor)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Conversation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
subscription_id | string | null | Yes | |
subscription_status | string | null | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
contact | string | Yes | |
opted_in | boolean | Yes | |
last_message_at | string | Yes | |
last_inbound_at | string | null | Yes | |
last_direction | enum | null | Yes | |
last_message_preview | string | null | Yes | |
unread_count | integer | Yes | |
window | object | null | Yes | |
created_at | string | Yes | |
assignee_id | string | null | Yes | |
team_id | string | null | Yes | |
assigned_at | string | null | Yes | |
language | string | null | Yes | |
bot_active | boolean | Yes | |
last_seq | integer | Yes | |
visitor_last_read_seq | integer | Yes | |
visitor_last_delivered_seq | integer | Yes | |
agent_last_read_seq | integer | Yes | |
waiting_since | string | null | Yes | |
first_response_at | string | null | Yes | |
sla_due_at | string | null | Yes | |
resolved_at | string | null | Yes | |
visitor | object | null | Yes |
Example response:
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_status": "örnek",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"contact": "örnek",
"opted_in": true,
"last_message_at": "örnek",
"last_inbound_at": "örnek",
"last_direction": "inbound",
"last_message_preview": "örnek",
"unread_count": 1,
"window": {
"open": true,
"expires_at": "örnek"
},
"created_at": "örnek",
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek",
"language": "tr",
"bot_active": true,
"last_seq": 1,
"visitor_last_read_seq": 1,
"visitor_last_delivered_seq": 1,
"agent_last_read_seq": 1,
"waiting_since": "örnek",
"first_response_at": "örnek",
"sla_due_at": "örnek",
"resolved_at": "örnek",
"visitor": {
"name": "Sipariş bildirimleri",
"email": "ayse@pushizo.com"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Assign the conversation to an agent and/or team (without inbox.manage, only to yourself)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ConversationAssignDto
| Field | Type | Required | Description |
|---|---|---|---|
assignee_id | string | null | No | |
team_id | string | null | No |
Example:
{
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
200 — Success.
Schema: Conversation
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
channel | enum | Yes | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" |
status | enum | Yes | Values: "open", "pending", "resolved", "closed" |
subscription_id | string | null | Yes | |
subscription_status | string | null | Yes | |
user_id | string | null | Yes | |
external_id | string | null | Yes | |
contact | string | Yes | |
opted_in | boolean | Yes | |
last_message_at | string | Yes | |
last_inbound_at | string | null | Yes | |
last_direction | enum | null | Yes | |
last_message_preview | string | null | Yes | |
unread_count | integer | Yes | |
window | object | null | Yes | |
created_at | string | Yes | |
assignee_id | string | null | Yes | |
team_id | string | null | Yes | |
assigned_at | string | null | Yes | |
language | string | null | Yes | |
bot_active | boolean | Yes | |
last_seq | integer | Yes | |
visitor_last_read_seq | integer | Yes | |
visitor_last_delivered_seq | integer | Yes | |
agent_last_read_seq | integer | Yes | |
waiting_since | string | null | Yes | |
first_response_at | string | null | Yes | |
sla_due_at | string | null | Yes | |
resolved_at | string | null | Yes | |
visitor | object | null | Yes |
Example response:
{
"channel": "sms",
"status": "open",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_status": "örnek",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"contact": "örnek",
"opted_in": true,
"last_message_at": "örnek",
"last_inbound_at": "örnek",
"last_direction": "inbound",
"last_message_preview": "örnek",
"unread_count": 1,
"window": {
"open": true,
"expires_at": "örnek"
},
"created_at": "örnek",
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"assigned_at": "örnek",
"language": "tr",
"bot_active": true,
"last_seq": 1,
"visitor_last_read_seq": 1,
"visitor_last_delivered_seq": 1,
"agent_last_read_seq": 1,
"waiting_since": "örnek",
"first_response_at": "örnek",
"sla_due_at": "örnek",
"resolved_at": "örnek",
"visitor": {
"name": "Sipariş bildirimleri",
"email": "ayse@pushizo.com"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/assign" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Add/remove a tag on the contact from the chat
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ConversationTagsDto
| Field | Type | Required | Description |
|---|---|---|---|
add | map<string, string> | No | |
remove | array<string> | No | Items: 0–50 |
Example:
{
"add": {
"key": "user_42"
},
"remove": [
"örnek"
]
}Responses
200 — Success.
Schema: ConversationTagsResult
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
tags | map<string, any> | Yes |
Example response:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/tags" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"add": {
"key": "user_42"
},
"remove": [
"örnek"
]
}'Conversation timeline (assignment, status, first response, bot handoff)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
conversationId | path | string | Yes | "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ConversationActivity
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].type | string | Yes | |
data[].actor_type | string | Yes | |
data[].actor_id | string | null | Yes | |
data[].data | map<string, any> | Yes | |
data[].created_at | string | Yes |
Example response:
{
"data": [
{
"data": {
"order_id": "1001"
},
"type": "örnek",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"actor_type": "örnek",
"actor_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/conversations/cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W/activity" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Two-way messaging keywords (org-wide + this app) and legal (reserved) keywords
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SmsKeywordList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].keyword | string | Yes | |
data[].scope | enum | Yes | Values: "org", "app" |
data[].app_id | string | null | Yes | |
data[].channels | array<enum> | Yes | |
data[].actions | map<string, any> | Yes | |
data[].enabled | boolean | Yes | |
data[].description | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
reserved | array<string> | Yes |
Example response:
{
"data": [
{
"channels": [
"sms"
],
"enabled": true,
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"keyword": "örnek",
"scope": "org",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"actions": {
"key": "örnek"
},
"description": "Sipariş durumu güncellemeleri",
"created_at": "örnek",
"updated_at": "örnek"
}
],
"reserved": [
"örnek"
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sms-keywords" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a keyword (add/remove tag, event → journey trigger, auto-reply, subscription)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateKeywordDto
| Field | Type | Required | Description |
|---|---|---|---|
keyword | string | Yes | Length: 1–30 |
scope | enum | No | Values: "org", "app" |
channels | array<enum> | No | Items: 1–3 |
actions | object | Yes | |
actions.add_tags | map<string, string> | No | |
actions.remove_tags | array<string> | No | Items: 0–50 |
actions.event | object | No | |
actions.event.name | string | Yes | |
actions.event.properties | map<string, string> | No | |
actions.reply | object | No | |
actions.reply.text | string | Yes | Length: 1–1600 |
actions.opt_in | boolean | No | |
enabled | boolean | No | |
description | string | No | Length: 0–300 |
Example:
{
"keyword": "örnek",
"actions": {
"add_tags": {
"key": "user_42"
},
"remove_tags": [
"örnek"
],
"event": {
"name": "purchase",
"properties": {
"order_id": "1001"
}
}
},
"channels": [
"sms"
],
"enabled": true,
"scope": "org",
"description": "Sipariş durumu güncellemeleri"
}Responses
201 — Success.
Schema: SmsKeyword
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
keyword | string | Yes | |
scope | enum | Yes | Values: "org", "app" |
app_id | string | null | Yes | |
channels | array<enum> | Yes | |
actions | map<string, any> | Yes | |
enabled | boolean | Yes | |
description | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"channels": [
"sms"
],
"enabled": true,
"id": "smk_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"keyword": "örnek",
"scope": "org",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"actions": {
"key": "örnek"
},
"description": "Sipariş durumu güncellemeleri",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sms-keywords" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"keyword": "örnek",
"actions": {
"add_tags": {
"key": "user_42"
},
"remove_tags": [
"örnek"
],
"event": {
"name": "purchase",
"properties": {
"order_id": "1001"
}
}
},
"channels": [
"sms"
],
"enabled": true,
"scope": "org",
"description": "Sipariş durumu güncellemeleri"
}'Update a keyword
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
keywordId | path | string | Yes | "smk_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateKeywordDto
| Field | Type | Required | Description |
|---|---|---|---|
keyword | string | No | Length: 1–30 |
channels | array<enum> | No | Items: 1–3 |
actions | object | No | |
actions.add_tags | map<string, string> | No | |
actions.remove_tags | array<string> | No | Items: 0–50 |
actions.event | object | No | |
actions.event.name | string | Yes | |
actions.event.properties | map<string, string> | No | |
actions.reply | object | No | |
actions.reply.text | string | Yes | Length: 1–1600 |
actions.opt_in | boolean | No | |
enabled | boolean | No | |
description | string | null | No |
Example:
{
"channels": [
"sms"
],
"enabled": true,
"keyword": "örnek",
"actions": {
"add_tags": {
"key": "user_42"
},
"remove_tags": [
"örnek"
],
"event": {
"name": "purchase",
"properties": {
"order_id": "1001"
}
}
},
"description": "Sipariş durumu güncellemeleri"
}Responses
200 — Success.
Schema: SmsKeyword
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
keyword | string | Yes | |
scope | enum | Yes | Values: "org", "app" |
app_id | string | null | Yes | |
channels | array<enum> | Yes | |
actions | map<string, any> | Yes | |
enabled | boolean | Yes | |
description | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"channels": [
"sms"
],
"enabled": true,
"id": "smk_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"keyword": "örnek",
"scope": "org",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"actions": {
"key": "örnek"
},
"description": "Sipariş durumu güncellemeleri",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sms-keywords/smk_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channels": [
"sms"
],
"enabled": true,
"keyword": "örnek",
"actions": {
"add_tags": {
"key": "user_42"
},
"remove_tags": [
"örnek"
],
"event": {
"name": "purchase",
"properties": {
"order_id": "1001"
}
}
},
"description": "Sipariş durumu güncellemeleri"
}'Delete a keyword
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
keywordId | path | string | Yes | "smk_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/sms-keywords/smk_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"WhatsApp templates (with Meta approval status)
Authentication: API key — scope notifications:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
status | query | string | No | Length: 0–30 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WhatsAppTemplateList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].language | string | Yes | |
data[].category | string | Yes | |
data[].status | string | Yes | |
data[].components | array<map<string, any>> | Yes | |
data[].body_params | integer | Yes | |
data[].rejected_reason | string | null | Yes | |
data[].quality_score | string | null | Yes | |
data[].synced_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "örnek",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"language": "tr",
"category": "örnek",
"components": [
{
"key": "örnek"
}
],
"body_params": 1,
"rejected_reason": "örnek",
"quality_score": "örnek",
"synced_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/whatsapp/templates" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Sync WhatsApp templates from the Meta Graph API
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WhatsAppTemplateSync
| Field | Type | Required | Description |
|---|---|---|---|
total | integer | Yes | |
removed | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].name | string | Yes | |
data[].language | string | Yes | |
data[].category | string | Yes | |
data[].status | string | Yes | |
data[].components | array<map<string, any>> | Yes | |
data[].body_params | integer | Yes | |
data[].rejected_reason | string | null | Yes | |
data[].quality_score | string | null | Yes | |
data[].synced_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "örnek",
"id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"language": "tr",
"category": "örnek",
"components": [
{
"key": "örnek"
}
],
"body_params": 1,
"rejected_reason": "örnek",
"quality_score": "örnek",
"synced_at": "örnek"
}
],
"total": 1,
"removed": 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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/whatsapp/templates/sync" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"iOS Live Activities
iOS Live Activities — 7 operations (GET /v1/apps/{appId}/live-activities/types, POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}, …). Generated from the OpenAPI 3.1.0 contract.
Email deliverability
Email deliverability — 17 operations (GET /v1/apps/{appId}/email-deliverability, PUT /v1/apps/{appId}/email-deliverability, POST /v1/apps/{appId}/email-deliverability/verify-address, …). Generated from the OpenAPI 3.1.0 contract.