PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/canned-responsesCanned responses
POST/v1/apps/{appId}/canned-responsesCreate 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/teamsTeams
POST/v1/apps/{appId}/inbox/teamsCreate 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-rulesAssignment rules (evaluated in order)
POST/v1/apps/{appId}/inbox/assignment-rulesCreate 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/agentsAgents and presence status
PATCH/v1/apps/{appId}/inbox/agents/{accountId}Agent routing profile: concurrent conversation limit and languages
GET/v1/apps/{appId}/inbox/settingsInbox settings
PUT/v1/apps/{appId}/inbox/settingsUpdate inbox settings
GET/v1/apps/{appId}/inbox/metricsInbox metrics (first response/resolution average and p90, SLA, agent table)
GET/v1/apps/{appId}/users/by/{label}/{value}/inboxThe user's notification inbox (including unread count)
POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/read-allMark all as read
POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}/readMark as read
DELETE/v1/apps/{appId}/users/by/{label}/{value}/inbox/{itemId}Remove from inbox (archive)

Details

Canned responses

GET/v1/apps/{appId}/canned-responsesTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
qquerystringNoLength: 0–100"ayse"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CannedResponseList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].shortcutstringYes
data[].titlestringYes
data[].bodystringYes
data[].languagestring | nullYes
data[].created_atstringYes
data[].updated_atstringYes

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

POST/v1/apps/{appId}/canned-responsesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CannedInputDto

FieldTypeRequiredDescription
shortcutstringYes
titlestringYesLength: 1–120
bodystringYesLength: 1–4000
languagestring | nullNo

Example:

{
  "shortcut": "değer",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "language": "tr"
}

Responses

201 — Success.

Schema: CannedResponse

FieldTypeRequiredDescription
idstringYes
shortcutstringYes
titlestringYes
bodystringYes
languagestring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/canned-responses/{cannedId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
cannedIdpathstringYes"cnr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CannedUpdateDto

FieldTypeRequiredDescription
shortcutstringNo
titlestringNoLength: 1–120
bodystringNoLength: 1–4000
languagestring | nullNo

Example:

{
  "shortcut": "değer",
  "title": "Siparişiniz yola çıktı",
  "body": "Takip bağlantısı içeride",
  "language": "tr"
}

Responses

200 — Success.

Schema: CannedResponse

FieldTypeRequiredDescription
idstringYes
shortcutstringYes
titlestringYes
bodystringYes
languagestring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/canned-responses/{cannedId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
cannedIdpathstringYes"cnr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/inbox/teamsTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxTeamList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].descriptionstring | nullYes
data[].member_idsarray<string>Yes
data[].created_atstringYes
data[].updated_atstringYes

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)

POST/v1/apps/{appId}/inbox/teamsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: TeamInputDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
descriptionstring | nullNo
member_idsarray<string>NoItems: 0–200

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "member_ids": [
    "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  ]
}

Responses

201 — Success.

Schema: InboxTeam

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
member_idsarray<string>Yes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/inbox/teams/{teamId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
teamIdpathstringYes"itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: TeamUpdateDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
descriptionstring | nullNo
member_idsarray<string>NoItems: 0–200

Example:

{
  "name": "Sipariş bildirimleri",
  "description": "Sipariş durumu güncellemeleri",
  "member_ids": [
    "inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
  ]
}

Responses

200 — Success.

Schema: InboxTeam

FieldTypeRequiredDescription
idstringYes
namestringYes
descriptionstring | nullYes
member_idsarray<string>Yes
created_atstringYes
updated_atstringYes

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)

DELETE/v1/apps/{appId}/inbox/teams/{teamId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
teamIdpathstringYes"itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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)

GET/v1/apps/{appId}/inbox/assignment-rulesTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AssignmentRuleList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].namestringYes
data[].enabledbooleanYes
data[].positionintegerYes
data[].conditionsobjectYes
data[].conditions.channelsarray<enum>NoItems: 0–7
data[].conditions.languagesarray<string>NoItems: 0–20
data[].conditions.tagsmap<string, string>No
data[].strategyenumYesValues: "round_robin", "least_busy", "team_only"
data[].team_idstring | nullYes
data[].agent_idsarray<string>Yes
data[].created_atstringYes
data[].updated_atstringYes

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)

POST/v1/apps/{appId}/inbox/assignment-rulesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AssignmentRuleInputDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
positionintegerNoRange: 0–10000
conditionsobjectNo
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumNoValues: "round_robin", "least_busy", "team_only"
team_idstring | nullNo
agent_idsarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
namestringYes
enabledbooleanYes
positionintegerYes
conditionsobjectYes
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumYesValues: "round_robin", "least_busy", "team_only"
team_idstring | nullYes
agent_idsarray<string>Yes
created_atstringYes
updated_atstringYes

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)

PATCH/v1/apps/{appId}/inbox/assignment-rules/{ruleId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
ruleIdpathstringYes"bar_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AssignmentRuleUpdateDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
positionintegerNoRange: 0–10000
conditionsobjectNo
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumNoValues: "round_robin", "least_busy", "team_only"
team_idstring | nullNo
agent_idsarray<string>NoItems: 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

FieldTypeRequiredDescription
idstringYes
namestringYes
enabledbooleanYes
positionintegerYes
conditionsobjectYes
conditions.channelsarray<enum>NoItems: 0–7
conditions.languagesarray<string>NoItems: 0–20
conditions.tagsmap<string, string>No
strategyenumYesValues: "round_robin", "least_busy", "team_only"
team_idstring | nullYes
agent_idsarray<string>Yes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/inbox/assignment-rules/{ruleId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
ruleIdpathstringYes"bar_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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

GET/v1/apps/{appId}/inbox/agentsTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].account_idstringYes
data[].namestringYes
data[].emailstringYes
data[].rolestringYes
data[].statusenumYesValues: "online", "busy", "offline"
data[].last_heartbeat_atstring | nullYes
data[].max_concurrentinteger | nullYes
data[].languagesarray<string>Yes
data[].open_conversationsintegerYes
data[].team_idsarray<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

PATCH/v1/apps/{appId}/inbox/agents/{accountId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
accountIdpathstringYes"ada_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AgentUpdateDto

FieldTypeRequiredDescription
max_concurrentinteger | nullNo
languagesarray<string>NoItems: 0–20

Example:

{
  "max_concurrent": 1,
  "languages": [
    "tr"
  ]
}

Responses

200 — Success.

Schema: InboxAgent

FieldTypeRequiredDescription
account_idstringYes
namestringYes
emailstringYes
rolestringYes
statusenumYesValues: "online", "busy", "offline"
last_heartbeat_atstring | nullYes
max_concurrentinteger | nullYes
languagesarray<string>Yes
open_conversationsintegerYes
team_idsarray<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

GET/v1/apps/{appId}/inbox/settingsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxSettings

FieldTypeRequiredDescription
widgetobjectYes
widget.enabledbooleanNo
widget.colorstringNo
widget.text_colorstringNo
widget.positionenumNoValues: "right", "left"
widget.themeenumNoValues: "light", "dark", "auto"
widget.titlemap<string, string>No
widget.greetingmap<string, string>No
widget.offline_messagemap<string, string>No
widget.collect_email_offlinebooleanNo
widget.attachmentsbooleanNo
widget.require_emailbooleanNo
business_hoursobjectYes
business_hours.enabledbooleanNo
business_hours.timezonestring | nullNo
business_hours.daysarray<object>NoItems: 0–21
business_hours.days[].dayintegerYesRange: 0–6
business_hours.days[].startstringYes
business_hours.days[].endstringYes
business_hours.holidaysarray<string>NoItems: 0–100
routingobjectYes
routing.auto_assignbooleanYes
routing.visibilityenumYesValues: "all", "team", "assigned"
routing.show_unassignedbooleanYes
routing.first_response_sla_secondsintegerYes
routing.max_concurrent_defaultinteger | nullYes
emailobjectYes
email.capture_repliesbooleanYes
email.reply_domainstring | nullYes
timezonestringYes
within_business_hoursbooleanYes
installobjectYes
install.app_idstringYes
install.sdk_urlstringYes
install.api_urlstringYes

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

PUT/v1/apps/{appId}/inbox/settingsTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: InboxSettingsUpdateDto

FieldTypeRequiredDescription
widgetobjectNo
widget.enabledbooleanNo
widget.colorstringNo
widget.text_colorstringNo
widget.positionenumNoValues: "right", "left"
widget.themeenumNoValues: "light", "dark", "auto"
widget.titlemap<string, string>No
widget.greetingmap<string, string>No
widget.offline_messagemap<string, string>No
widget.collect_email_offlinebooleanNo
widget.attachmentsbooleanNo
widget.require_emailbooleanNo
business_hoursobjectNo
business_hours.enabledbooleanNo
business_hours.timezonestring | nullNo
business_hours.daysarray<object>NoItems: 0–21
business_hours.days[].dayintegerYesRange: 0–6
business_hours.days[].startstringYes
business_hours.days[].endstringYes
business_hours.holidaysarray<string>NoItems: 0–100
routingobjectNo
routing.auto_assignbooleanNo
routing.visibilityenumNoValues: "all", "team", "assigned"
routing.show_unassignedbooleanNo
routing.first_response_sla_secondsintegerNoRange: 30–604800
routing.max_concurrent_defaultinteger | nullNo
emailobjectNo
email.capture_repliesbooleanNo

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

FieldTypeRequiredDescription
widgetobjectYes
widget.enabledbooleanNo
widget.colorstringNo
widget.text_colorstringNo
widget.positionenumNoValues: "right", "left"
widget.themeenumNoValues: "light", "dark", "auto"
widget.titlemap<string, string>No
widget.greetingmap<string, string>No
widget.offline_messagemap<string, string>No
widget.collect_email_offlinebooleanNo
widget.attachmentsbooleanNo
widget.require_emailbooleanNo
business_hoursobjectYes
business_hours.enabledbooleanNo
business_hours.timezonestring | nullNo
business_hours.daysarray<object>NoItems: 0–21
business_hours.days[].dayintegerYesRange: 0–6
business_hours.days[].startstringYes
business_hours.days[].endstringYes
business_hours.holidaysarray<string>NoItems: 0–100
routingobjectYes
routing.auto_assignbooleanYes
routing.visibilityenumYesValues: "all", "team", "assigned"
routing.show_unassignedbooleanYes
routing.first_response_sla_secondsintegerYes
routing.max_concurrent_defaultinteger | nullYes
emailobjectYes
email.capture_repliesbooleanYes
email.reply_domainstring | nullYes
timezonestringYes
within_business_hoursbooleanYes
installobjectYes
install.app_idstringYes
install.sdk_urlstringYes
install.api_urlstringYes

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)

GET/v1/apps/{appId}/inbox/metricsTry it (interactive API docs, new tab)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"
channelqueryenumNoValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat""sms"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxMetrics

FieldTypeRequiredDescription
fromstringYes
tostringYes
first_responseobjectYes
first_response.countintegerYes
first_response.avg_secondsnumber | nullYes
first_response.p90_secondsnumber | nullYes
resolutionobjectYes
resolution.countintegerYes
resolution.avg_secondsnumber | nullYes
resolution.p90_secondsnumber | nullYes
slaobjectYes
sla.target_secondsintegerYes
sla.metintegerYes
sla.breachedintegerYes
sla.ratenumber | nullYes
volumeobjectYes
volume.createdintegerYes
volume.resolvedintegerYes
volume.open_nowintegerYes
volume.unassigned_nowintegerYes
volume.by_channelmap<string, integer>Yes
agentsarray<object>Yes
agents[].account_idstringYes
agents[].namestring | nullYes
agents[].first_responseobjectYes
agents[].first_response.countintegerYes
agents[].first_response.avg_secondsnumber | nullYes
agents[].first_response.p90_secondsnumber | nullYes
agents[].resolutionobjectYes
agents[].resolution.countintegerYes
agents[].resolution.avg_secondsnumber | nullYes
agents[].resolution.p90_secondsnumber | nullYes
agents[].resolvedintegerYes
agents[].open_nowintegerYes
dailyarray<object>Yes
daily[].datestringYes
daily[].createdintegerYes
daily[].resolvedintegerYes
daily[].first_response_avg_secondsnumber | nullYes

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)

GET/v1/apps/{appId}/users/by/{label}/{value}/inboxTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
include_archivedqueryenumNoValues: "true", "false""true"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].message_idstring | nullYes
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].urlstring | nullYes
data[].image_urlstring | nullYes
data[].datamap<string, string>Yes
data[].readbooleanYes
data[].read_atstring | nullYes
data[].archived_atstring | nullYes
data[].expires_atstring | nullYes
data[].created_atstringYes
unread_countintegerYes
next_cursorstring | nullYes
has_morebooleanYes

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

POST/v1/apps/{appId}/users/by/{label}/{value}/inbox/read-allTry it (interactive API docs, new tab)

Authentication: API key — scope users:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxReadAllResult

FieldTypeRequiredDescription
updatedintegerYes
unread_countintegerYes

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

POST/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

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InboxItem

FieldTypeRequiredDescription
idstringYes
message_idstring | nullYes
titlestring | nullYes
bodystring | nullYes
urlstring | nullYes
image_urlstring | nullYes
datamap<string, string>Yes
readbooleanYes
read_atstring | nullYes
archived_atstring | nullYes
expires_atstring | nullYes
created_atstringYes

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)

DELETE/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

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
itemIdpathstringYes"inb_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

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"

On this page