Notification inbox and inbox settings
Notification inbox and inbox settings — 21 operations (GET /v1/apps/{appId}/canned-responses, POST /v1/apps/{appId}/canned-responses, PATCH /v1/apps/{appId}/canned-responses/{cannedId}, …). Generated from the OpenAPI 3.1.0 contract.
The user's notification inbox (list, mark as read, mark all as read, archive) and the agent side of the unified inbox: canned responses, teams, agent presence, business hours/SLA settings and metrics.
Base URL: https://api.pushizo.com · Tag: inbox · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/canned-responses | Canned responses |
POST | /v1/apps/{appId}/canned-responses | Create a canned response |
PATCH | /v1/apps/{appId}/canned-responses/{cannedId} | Update a canned response |
DELETE | /v1/apps/{appId}/canned-responses/{cannedId} | Delete a canned response |
GET | /v1/apps/{appId}/inbox/teams | Teams |
POST | /v1/apps/{appId}/inbox/teams | Create a team (members are organization members with a reply role) |
PATCH | /v1/apps/{appId}/inbox/teams/{teamId} | Update a team |
DELETE | /v1/apps/{appId}/inbox/teams/{teamId} | Delete a team (conversations lose their team assignment) |
GET | /v1/apps/{appId}/inbox/assignment-rules | Assignment rules (evaluated in order) |
POST | /v1/apps/{appId}/inbox/assignment-rules | Create an assignment rule (channel/language/tag conditions; round-robin, least busy or team only) |
PATCH | /v1/apps/{appId}/inbox/assignment-rules/{ruleId} | Update an assignment rule (including its position) |
DELETE | /v1/apps/{appId}/inbox/assignment-rules/{ruleId} | Delete an assignment rule |
GET | /v1/apps/{appId}/inbox/agents | Agents and presence status |
PATCH | /v1/apps/{appId}/inbox/agents/{accountId} | Agent routing profile: concurrent conversation limit and languages |
GET | /v1/apps/{appId}/inbox/settings | Inbox settings |
PUT | /v1/apps/{appId}/inbox/settings | Update inbox settings |
GET | /v1/apps/{appId}/inbox/metrics | Inbox metrics (first response/resolution average and p90, SLA, agent table) |
GET | /v1/apps/{appId}/users/by/{label}/{value}/inbox | The user's notification inbox (including unread count) |
POST | /v1/apps/{appId}/users/by/{label}/{value}/inbox/read-all | Mark all as read |
POST | /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/read | Mark as read |
DELETE | /v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId} | Remove from inbox (archive) |
Details
Canned responses
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
q | query | string | No | Length: 0–100 | "ayse" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CannedResponseList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].shortcut | string | Yes | |
data[].title | string | Yes | |
data[].body | string | Yes | |
data[].language | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"shortcut": "örnek",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr",
"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/canned-responses" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a canned response
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: CannedInputDto
| Field | Type | Required | Description |
|---|---|---|---|
shortcut | string | Yes | |
title | string | Yes | Length: 1–120 |
body | string | Yes | Length: 1–4000 |
language | string | null | No |
Example:
{
"shortcut": "değer",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr"
}Responses
201 — Success.
Schema: CannedResponse
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
shortcut | string | Yes | |
title | string | Yes | |
body | string | Yes | |
language | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"shortcut": "örnek",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr",
"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/canned-responses" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shortcut": "değer",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr"
}'Update a canned response
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
cannedId | path | string | Yes | "cnr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CannedUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
shortcut | string | No | |
title | string | No | Length: 1–120 |
body | string | No | Length: 1–4000 |
language | string | null | No |
Example:
{
"shortcut": "değer",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr"
}Responses
200 — Success.
Schema: CannedResponse
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
shortcut | string | Yes | |
title | string | Yes | |
body | string | Yes | |
language | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"id": "srs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"shortcut": "örnek",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr",
"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/canned-responses/cnr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"shortcut": "değer",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"language": "tr"
}'Delete a canned response
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
cannedId | path | string | Yes | "cnr_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/canned-responses/cnr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Teams
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: InboxTeamList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].description | string | null | Yes | |
data[].member_ids | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/teams" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a team (members are organization members with a reply role)
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: TeamInputDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
description | string | null | No | |
member_ids | array<string> | No | Items: 0–200 |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}Responses
201 — Success.
Schema: InboxTeam
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
member_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/teams" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}'Update a team
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
teamId | path | string | Yes | "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: TeamUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
description | string | null | No | |
member_ids | array<string> | No | Items: 0–200 |
Example:
{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}Responses
200 — Success.
Schema: InboxTeam
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
description | string | null | Yes | |
member_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/teams/itm_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"description": "Sipariş durumu güncellemeleri",
"member_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
]
}'Delete a team (conversations lose their team assignment)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
teamId | path | string | Yes | "itm_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/inbox/teams/itm_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Assignment rules (evaluated in order)
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: AssignmentRuleList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].name | string | Yes | |
data[].enabled | boolean | Yes | |
data[].position | integer | Yes | |
data[].conditions | object | Yes | |
data[].conditions.channels | array<enum> | No | Items: 0–7 |
data[].conditions.languages | array<string> | No | Items: 0–20 |
data[].conditions.tags | map<string, string> | No | |
data[].strategy | enum | Yes | Values: "round_robin", "least_busy", "team_only" |
data[].team_id | string | null | Yes | |
data[].agent_ids | array<string> | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
}
},
"strategy": "round_robin",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"agent_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/assignment-rules" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an assignment rule (channel/language/tag conditions; round-robin, least busy or team only)
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: AssignmentRuleInputDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Length: 1–80 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
conditions | object | No | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | No | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | No | |
agent_ids | array<string> | No | Items: 0–200 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}Responses
201 — Success.
Schema: AssignmentRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
position | integer | Yes | |
conditions | object | Yes | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | Yes | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | Yes | |
agent_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"agent_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/assignment-rules" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'Update an assignment rule (including its position)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ruleId | path | string | Yes | "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: AssignmentRuleUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–80 |
enabled | boolean | No | |
position | integer | No | Range: 0–10000 |
conditions | object | No | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | No | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | No | |
agent_ids | array<string> | No | Items: 0–200 |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin"
}Responses
200 — Success.
Schema: AssignmentRule
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
name | string | Yes | |
enabled | boolean | Yes | |
position | integer | Yes | |
conditions | object | Yes | |
conditions.channels | array<enum> | No | Items: 0–7 |
conditions.languages | array<string> | No | Items: 0–20 |
conditions.tags | map<string, string> | No | |
strategy | enum | Yes | Values: "round_robin", "least_busy", "team_only" |
team_id | string | null | Yes | |
agent_ids | array<string> | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"id": "bar_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin",
"team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"agent_ids": [
"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
],
"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/inbox/assignment-rules/bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"position": 1,
"conditions": {
"channels": [
"sms"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"languages": [
"tr"
]
},
"strategy": "round_robin"
}'Delete an assignment rule
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
ruleId | path | string | Yes | "bar_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/inbox/assignment-rules/bar_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Agents and presence status
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: InboxAgentList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].account_id | string | Yes | |
data[].name | string | Yes | |
data[].email | string | Yes | |
data[].role | string | Yes | |
data[].status | enum | Yes | Values: "online", "busy", "offline" |
data[].last_heartbeat_at | string | null | Yes | |
data[].max_concurrent | integer | null | Yes | |
data[].languages | array<string> | Yes | |
data[].open_conversations | integer | Yes | |
data[].team_ids | array<string> | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"status": "online",
"account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"role": "örnek",
"last_heartbeat_at": "örnek",
"max_concurrent": 1,
"languages": [
"tr"
],
"open_conversations": 1,
"team_ids": [
"itm_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/agents" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Agent routing profile: concurrent conversation limit and languages
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
accountId | path | string | Yes | "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: AgentUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
max_concurrent | integer | null | No | |
languages | array<string> | No | Items: 0–20 |
Example:
{
"max_concurrent": 1,
"languages": [
"tr"
]
}Responses
200 — Success.
Schema: InboxAgent
| Field | Type | Required | Description |
|---|---|---|---|
account_id | string | Yes | |
name | string | Yes | |
email | string | Yes | |
role | string | Yes | |
status | enum | Yes | Values: "online", "busy", "offline" |
last_heartbeat_at | string | null | Yes | |
max_concurrent | integer | null | Yes | |
languages | array<string> | Yes | |
open_conversations | integer | Yes | |
team_ids | array<string> | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"status": "online",
"account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"email": "ayse@pushizo.com",
"role": "örnek",
"last_heartbeat_at": "örnek",
"max_concurrent": 1,
"languages": [
"tr"
],
"open_conversations": 1,
"team_ids": [
"itm_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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/agents/ada_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"max_concurrent": 1,
"languages": [
"tr"
]
}'Inbox settings
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: InboxSettings
| Field | Type | Required | Description |
|---|---|---|---|
widget | object | Yes | |
widget.enabled | boolean | No | |
widget.color | string | No | |
widget.text_color | string | No | |
widget.position | enum | No | Values: "right", "left" |
widget.theme | enum | No | Values: "light", "dark", "auto" |
widget.title | map<string, string> | No | |
widget.greeting | map<string, string> | No | |
widget.offline_message | map<string, string> | No | |
widget.collect_email_offline | boolean | No | |
widget.attachments | boolean | No | |
widget.require_email | boolean | No | |
business_hours | object | Yes | |
business_hours.enabled | boolean | No | |
business_hours.timezone | string | null | No | |
business_hours.days | array<object> | No | Items: 0–21 |
business_hours.days[].day | integer | Yes | Range: 0–6 |
business_hours.days[].start | string | Yes | |
business_hours.days[].end | string | Yes | |
business_hours.holidays | array<string> | No | Items: 0–100 |
routing | object | Yes | |
routing.auto_assign | boolean | Yes | |
routing.visibility | enum | Yes | Values: "all", "team", "assigned" |
routing.show_unassigned | boolean | Yes | |
routing.first_response_sla_seconds | integer | Yes | |
routing.max_concurrent_default | integer | null | Yes | |
email | object | Yes | |
email.capture_replies | boolean | Yes | |
email.reply_domain | string | null | Yes | |
timezone | string | Yes | |
within_business_hours | boolean | Yes | |
install | object | Yes | |
install.app_id | string | Yes | |
install.sdk_url | string | Yes | |
install.api_url | string | Yes |
Example response:
{
"widget": {
"enabled": true,
"color": "değer",
"text_color": "değer",
"position": "right"
},
"business_hours": {
"enabled": true,
"timezone": "Europe/Istanbul",
"days": [
{
"day": 1,
"start": "2026-10-01T00:00:00Z",
"end": "2026-10-17T00:00:00Z"
}
],
"holidays": [
"değer"
]
},
"routing": {
"auto_assign": true,
"visibility": "all",
"show_unassigned": true,
"first_response_sla_seconds": 1,
"max_concurrent_default": 1
},
"email": {
"capture_replies": true,
"reply_domain": "örnek"
},
"timezone": "Europe/Istanbul",
"within_business_hours": true,
"install": {
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sdk_url": "https://pushizo.com/orders/1001",
"api_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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/settings" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update inbox settings
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: InboxSettingsUpdateDto
| Field | Type | Required | Description |
|---|---|---|---|
widget | object | No | |
widget.enabled | boolean | No | |
widget.color | string | No | |
widget.text_color | string | No | |
widget.position | enum | No | Values: "right", "left" |
widget.theme | enum | No | Values: "light", "dark", "auto" |
widget.title | map<string, string> | No | |
widget.greeting | map<string, string> | No | |
widget.offline_message | map<string, string> | No | |
widget.collect_email_offline | boolean | No | |
widget.attachments | boolean | No | |
widget.require_email | boolean | No | |
business_hours | object | No | |
business_hours.enabled | boolean | No | |
business_hours.timezone | string | null | No | |
business_hours.days | array<object> | No | Items: 0–21 |
business_hours.days[].day | integer | Yes | Range: 0–6 |
business_hours.days[].start | string | Yes | |
business_hours.days[].end | string | Yes | |
business_hours.holidays | array<string> | No | Items: 0–100 |
routing | object | No | |
routing.auto_assign | boolean | No | |
routing.visibility | enum | No | Values: "all", "team", "assigned" |
routing.show_unassigned | boolean | No | |
routing.first_response_sla_seconds | integer | No | Range: 30–604800 |
routing.max_concurrent_default | integer | null | No | |
email | object | No | |
email.capture_replies | boolean | No |
Example:
{
"widget": {
"enabled": true,
"color": "değer",
"text_color": "değer"
},
"business_hours": {
"enabled": true,
"timezone": "Europe/Istanbul",
"days": [
{
"day": 1,
"start": "2026-10-01T00:00:00Z",
"end": "2026-10-17T00:00:00Z"
}
]
},
"routing": {
"auto_assign": true,
"visibility": "all",
"show_unassigned": true
},
"email": {
"capture_replies": true
}
}Responses
200 — Success.
Schema: InboxSettings
| Field | Type | Required | Description |
|---|---|---|---|
widget | object | Yes | |
widget.enabled | boolean | No | |
widget.color | string | No | |
widget.text_color | string | No | |
widget.position | enum | No | Values: "right", "left" |
widget.theme | enum | No | Values: "light", "dark", "auto" |
widget.title | map<string, string> | No | |
widget.greeting | map<string, string> | No | |
widget.offline_message | map<string, string> | No | |
widget.collect_email_offline | boolean | No | |
widget.attachments | boolean | No | |
widget.require_email | boolean | No | |
business_hours | object | Yes | |
business_hours.enabled | boolean | No | |
business_hours.timezone | string | null | No | |
business_hours.days | array<object> | No | Items: 0–21 |
business_hours.days[].day | integer | Yes | Range: 0–6 |
business_hours.days[].start | string | Yes | |
business_hours.days[].end | string | Yes | |
business_hours.holidays | array<string> | No | Items: 0–100 |
routing | object | Yes | |
routing.auto_assign | boolean | Yes | |
routing.visibility | enum | Yes | Values: "all", "team", "assigned" |
routing.show_unassigned | boolean | Yes | |
routing.first_response_sla_seconds | integer | Yes | |
routing.max_concurrent_default | integer | null | Yes | |
email | object | Yes | |
email.capture_replies | boolean | Yes | |
email.reply_domain | string | null | Yes | |
timezone | string | Yes | |
within_business_hours | boolean | Yes | |
install | object | Yes | |
install.app_id | string | Yes | |
install.sdk_url | string | Yes | |
install.api_url | string | Yes |
Example response:
{
"widget": {
"enabled": true,
"color": "değer",
"text_color": "değer",
"position": "right"
},
"business_hours": {
"enabled": true,
"timezone": "Europe/Istanbul",
"days": [
{
"day": 1,
"start": "2026-10-01T00:00:00Z",
"end": "2026-10-17T00:00:00Z"
}
],
"holidays": [
"değer"
]
},
"routing": {
"auto_assign": true,
"visibility": "all",
"show_unassigned": true,
"first_response_sla_seconds": 1,
"max_concurrent_default": 1
},
"email": {
"capture_replies": true,
"reply_domain": "örnek"
},
"timezone": "Europe/Istanbul",
"within_business_hours": true,
"install": {
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sdk_url": "https://pushizo.com/orders/1001",
"api_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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/settings" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"widget": {
"enabled": true,
"color": "değer",
"text_color": "değer"
},
"business_hours": {
"enabled": true,
"timezone": "Europe/Istanbul",
"days": [
{
"day": 1,
"start": "2026-10-01T00:00:00Z",
"end": "2026-10-17T00:00:00Z"
}
]
},
"routing": {
"auto_assign": true,
"visibility": "all",
"show_unassigned": true
},
"email": {
"capture_replies": true
}
}'Inbox metrics (first response/resolution average and p90, SLA, agent table)
Authentication: API key — scope analytics:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
from | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
to | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
channel | query | enum | No | Values: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat" | "sms" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: InboxMetrics
| Field | Type | Required | Description |
|---|---|---|---|
from | string | Yes | |
to | string | Yes | |
first_response | object | Yes | |
first_response.count | integer | Yes | |
first_response.avg_seconds | number | null | Yes | |
first_response.p90_seconds | number | null | Yes | |
resolution | object | Yes | |
resolution.count | integer | Yes | |
resolution.avg_seconds | number | null | Yes | |
resolution.p90_seconds | number | null | Yes | |
sla | object | Yes | |
sla.target_seconds | integer | Yes | |
sla.met | integer | Yes | |
sla.breached | integer | Yes | |
sla.rate | number | null | Yes | |
volume | object | Yes | |
volume.created | integer | Yes | |
volume.resolved | integer | Yes | |
volume.open_now | integer | Yes | |
volume.unassigned_now | integer | Yes | |
volume.by_channel | map<string, integer> | Yes | |
agents | array<object> | Yes | |
agents[].account_id | string | Yes | |
agents[].name | string | null | Yes | |
agents[].first_response | object | Yes | |
agents[].first_response.count | integer | Yes | |
agents[].first_response.avg_seconds | number | null | Yes | |
agents[].first_response.p90_seconds | number | null | Yes | |
agents[].resolution | object | Yes | |
agents[].resolution.count | integer | Yes | |
agents[].resolution.avg_seconds | number | null | Yes | |
agents[].resolution.p90_seconds | number | null | Yes | |
agents[].resolved | integer | Yes | |
agents[].open_now | integer | Yes | |
daily | array<object> | Yes | |
daily[].date | string | Yes | |
daily[].created | integer | Yes | |
daily[].resolved | integer | Yes | |
daily[].first_response_avg_seconds | number | null | Yes |
Example response:
{
"from": "2026-10-01T00:00:00Z",
"to": "2026-10-17T00:00:00Z",
"first_response": {
"count": 1,
"avg_seconds": 1.5,
"p90_seconds": 1.5
},
"resolution": {
"count": 1,
"avg_seconds": 1.5,
"p90_seconds": 1.5
},
"sla": {
"target_seconds": 1,
"met": 1,
"breached": 1,
"rate": 1.5
},
"volume": {
"created": 1,
"resolved": 1,
"open_now": 1,
"unassigned_now": 1,
"by_channel": {
"key": 150
}
},
"agents": [
{
"name": "Sipariş bildirimleri",
"account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"first_response": {
"count": 1,
"avg_seconds": 1.5,
"p90_seconds": 1.5
},
"resolution": {
"count": 1,
"avg_seconds": 1.5,
"p90_seconds": 1.5
},
"resolved": 1,
"open_now": 1
}
],
"daily": [
{
"date": "örnek",
"created": 1,
"resolved": 1,
"first_response_avg_seconds": 1.5
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/inbox/metrics" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The user's notification inbox (including unread count)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
include_archived | query | enum | No | Values: "true", "false" | "true" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
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": "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"
}
],
"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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Mark all as read
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox/read-all" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Mark as read
/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/readTry it (interactive API docs, new tab)Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
itemId | path | string | Yes | "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
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/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W/read" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Remove from inbox (archive)
/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}Try it (interactive API docs, new tab)Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
itemId | path | string | Yes | "inb_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/users/by/external_id/user_42/inbox/inb_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"In-app messages
In-app messages — 7 operations (GET /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, …). Generated from the OpenAPI 3.1.0 contract.
Categories and preferences
Categories and preferences — 6 operations (GET /v1/apps/{appId}/categories, POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}, …). Generated from the OpenAPI 3.1.0 contract.