PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/ai-agentsAI agents
POST/v1/apps/{appId}/ai-agentsCreate an AI agent
GET/v1/apps/{appId}/ai-agents/runsAI agent runs
GET/v1/apps/{appId}/ai-agents/{agentId}AI agent
PATCH/v1/apps/{appId}/ai-agents/{agentId}Update an AI agent
DELETE/v1/apps/{appId}/ai-agents/{agentId}Delete an AI agent
POST/v1/apps/{appId}/ai-agents/{agentId}/rotate-secretRotate the tool signing secret
GET/v1/apps/{appId}/ai-agents/{agentId}/metricsAI agent metrics (last 30 days)
GET/v1/apps/{appId}/conversationsConversations (SMS, WhatsApp, RCS, email, live chat; ordered by last message; channel/status/unread/assignee/team/contact filters)
GET/v1/apps/{appId}/conversations/{conversationId}Conversation (including assignment, SLA, bot status, WhatsApp session window and opt-in)
PATCH/v1/apps/{appId}/conversations/{conversationId}Conversation status: open / pending / resolved (closed = resolved)
GET/v1/apps/{appId}/conversations/{conversationId}/contactContact profile: properties, tags, subscriptions (masked), recent events and other conversations
GET/v1/apps/{appId}/conversations/{conversationId}/messagesConversation messages (newest first; oldest first with after_seq; outbound message status comes from the delivery or the read receipt)
POST/v1/apps/{appId}/conversations/{conversationId}/messagesSend 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).
POST/v1/apps/{appId}/conversations/{conversationId}/readMark inbound messages as read (in chat, a read receipt is sent to the visitor)
POST/v1/apps/{appId}/conversations/{conversationId}/assignAssign the conversation to an agent and/or team (without inbox.manage, only to yourself)
POST/v1/apps/{appId}/conversations/{conversationId}/tagsAdd/remove a tag on the contact from the chat
GET/v1/apps/{appId}/conversations/{conversationId}/activityConversation timeline (assignment, status, first response, bot handoff)
GET/v1/apps/{appId}/sms-keywordsTwo-way messaging keywords (org-wide + this app) and legal (reserved) keywords
POST/v1/apps/{appId}/sms-keywordsCreate a keyword (add/remove tag, event → journey trigger, auto-reply, subscription)
PATCH/v1/apps/{appId}/sms-keywords/{keywordId}Update a keyword
DELETE/v1/apps/{appId}/sms-keywords/{keywordId}Delete a keyword
GET/v1/apps/{appId}/whatsapp/templatesWhatsApp templates (with Meta approval status)
POST/v1/apps/{appId}/whatsapp/templates/syncSync WhatsApp templates from the Meta Graph API

Details

AI agents

GET/v1/apps/{appId}/ai-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: AiAgentList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].enabledbooleanYes
data[].channelsarray<enum>Yes
data[].instructionsstringYes
data[].faqarray<object>Yes
data[].faq[].questionstringYes
data[].faq[].answerstringYes
data[].toolsarray<object>Yes
data[].tools[].namestringYes
data[].tools[].descriptionstringYes
data[].tools[].urlstringYes
data[].tools[].paramsarray<object>Yes
data[].handoffobjectYes
data[].handoff.keywordsarray<string>Yes
data[].handoff.max_bot_repliesintegerYes
data[].handoff.on_negative_sentimentbooleanYes
data[].handoff.messagestringYes
data[].limitsobjectYes
data[].limits.monthly_token_capintegerYes
data[].limits.max_stepsintegerYes
data[].ai_sentimentbooleanYes
data[].has_tool_secretbooleanYes
data[].usageobjectYes
data[].usage.tokens_this_monthintegerYes
data[].usage.period_startstringYes
data[].created_atstringYes
data[].updated_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateAiAgentDto

FieldTypeRequiredDescription
namestringYesLength: 1–80
enabledbooleanNo
channelsarray<enum>NoItems: 0–6
instructionsstringNoLength: 0–4000
faqarray<object>NoItems: 0–50
faq[].questionstringYesLength: 1–300
faq[].answerstringYesLength: 1–1500
toolsarray<object>NoItems: 0–10
tools[].namestringYes
tools[].descriptionstringYesLength: 1–500
tools[].urlstring (uri)YesLength: 0–2000
tools[].paramsarray<object>NoItems: 0–8
tools[].params[].namestringYes
tools[].params[].descriptionstringNoLength: 0–200
tools[].params[].requiredbooleanNo
handoffobjectNo
handoff.keywordsarray<string>NoItems: 0–20
handoff.max_bot_repliesintegerNoRange: 1–50
handoff.on_negative_sentimentbooleanNo
handoff.messagestringNoLength: 0–500
limitsobjectNo
limits.monthly_token_capintegerNoRange: 1000–50000000
limits.max_stepsintegerNoRange: 1–6
ai_sentimentbooleanNo

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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes
tool_secretstring | nullYes

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

GET/v1/apps/{appId}/ai-agents/runsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agent_idquerystringNo"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
conversation_idquerystringNo"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
statusqueryenumNoValues: "pending", "replied", "handed_off", "skipped_cap", "failed""pending"
limitqueryintegerNoRange: 1–10050
cursorquerystringNo"eyJpZCI6Im1zZ18wMUpE…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AiAgentRunList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].agent_idstringYes
data[].conversation_idstringYes
data[].statusenumYesValues: "pending", "replied", "handed_off", "skipped_cap", "failed"
data[].stepsarray<object>Yes
data[].steps[].kindenumYesValues: "reply", "tool", "handoff"
data[].steps[].toolstringNo
data[].steps[].statusinteger | nullNo
data[].steps[].okbooleanNo
data[].steps[].duration_msintegerNo
data[].input_tokensintegerYes
data[].output_tokensintegerYes
data[].handoff_reasonstring | nullYes
data[].errorstring | nullYes
data[].created_atstringYes
data[].finished_atstring | nullYes
next_cursorstring | nullYes
has_morebooleanYes

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

GET/v1/apps/{appId}/ai-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AiAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/ai-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAiAgentDto

FieldTypeRequiredDescription
namestringNoLength: 1–80
enabledbooleanNo
channelsarray<enum>NoItems: 0–6
instructionsstringNoLength: 0–4000
faqarray<object>NoItems: 0–50
faq[].questionstringYesLength: 1–300
faq[].answerstringYesLength: 1–1500
toolsarray<object>NoItems: 0–10
tools[].namestringYes
tools[].descriptionstringYesLength: 1–500
tools[].urlstring (uri)YesLength: 0–2000
tools[].paramsarray<object>NoItems: 0–8
tools[].params[].namestringYes
tools[].params[].descriptionstringNoLength: 0–200
tools[].params[].requiredbooleanNo
handoffobjectNo
handoff.keywordsarray<string>NoItems: 0–20
handoff.max_bot_repliesintegerNoRange: 1–50
handoff.on_negative_sentimentbooleanNo
handoff.messagestringNoLength: 0–500
limitsobjectNo
limits.monthly_token_capintegerNoRange: 1000–50000000
limits.max_stepsintegerNoRange: 1–6
ai_sentimentbooleanNo

Example:

{
  "name": "Sipariş bildirimleri",
  "channels": [
    "whatsapp"
  ],
  "enabled": true,
  "instructions": "örnek",
  "faq": [
    {
      "question": "örnek",
      "answer": "örnek"
    }
  ]
}

Responses

200 — Success.

Schema: AiAgent

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/ai-agents/{agentId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"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

POST/v1/apps/{appId}/ai-agents/{agentId}/rotate-secretTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AiAgentWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
enabledbooleanYes
channelsarray<enum>Yes
instructionsstringYes
faqarray<object>Yes
faq[].questionstringYes
faq[].answerstringYes
toolsarray<object>Yes
tools[].namestringYes
tools[].descriptionstringYes
tools[].urlstringYes
tools[].paramsarray<object>Yes
tools[].params[].namestringYes
tools[].params[].descriptionstringYes
tools[].params[].requiredbooleanYes
handoffobjectYes
handoff.keywordsarray<string>Yes
handoff.max_bot_repliesintegerYes
handoff.on_negative_sentimentbooleanYes
handoff.messagestringYes
limitsobjectYes
limits.monthly_token_capintegerYes
limits.max_stepsintegerYes
ai_sentimentbooleanYes
has_tool_secretbooleanYes
usageobjectYes
usage.tokens_this_monthintegerYes
usage.period_startstringYes
created_atstringYes
updated_atstringYes
tool_secretstring | nullYes

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)

GET/v1/apps/{appId}/ai-agents/{agentId}/metricsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
agentIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: AiAgentMetrics

FieldTypeRequiredDescription
period_daysintegerYes
runsintegerYes
repliedintegerYes
handed_offintegerYes
skipped_capintegerYes
failedintegerYes
conversationsintegerYes
resolution_ratenumberYes
avg_stepsnumberYes
tool_callsintegerYes
tool_error_ratenumberYes
tokensintegerYes
handoff_reasonsmap<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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
channelqueryenumNoValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat""sms"
statusqueryenumNoValues: "open", "pending", "resolved", "closed""open"
unreadqueryenumNoValues: "true", "false""true"
qquerystringNoLength: 2–255"ayse"
assigneequerystringNoLength: 2–64"örnek"
team_idquerystringNoLength: 1–64"itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ConversationPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
data[].statusenumYesValues: "open", "pending", "resolved", "closed"
data[].subscription_idstring | nullYes
data[].subscription_statusstring | nullYes
data[].user_idstring | nullYes
data[].external_idstring | nullYes
data[].contactstringYes
data[].opted_inbooleanYes
data[].last_message_atstringYes
data[].last_inbound_atstring | nullYes
data[].last_directionenum | nullYes
data[].last_message_previewstring | nullYes
data[].unread_countintegerYes
data[].windowobject | nullYes
data[].created_atstringYes
data[].assignee_idstring | nullYes
data[].team_idstring | nullYes
data[].assigned_atstring | nullYes
data[].languagestring | nullYes
data[].bot_activebooleanYes
data[].last_seqintegerYes
data[].visitor_last_read_seqintegerYes
data[].visitor_last_delivered_seqintegerYes
data[].agent_last_read_seqintegerYes
data[].waiting_sincestring | nullYes
data[].first_response_atstring | nullYes
data[].sla_due_atstring | nullYes
data[].resolved_atstring | nullYes
data[].visitorobject | nullYes
next_cursorstring | nullYes
has_morebooleanYes

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)

GET/v1/apps/{appId}/conversations/{conversationId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Conversation

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
statusenumYesValues: "open", "pending", "resolved", "closed"
subscription_idstring | nullYes
subscription_statusstring | nullYes
user_idstring | nullYes
external_idstring | nullYes
contactstringYes
opted_inbooleanYes
last_message_atstringYes
last_inbound_atstring | nullYes
last_directionenum | nullYes
last_message_previewstring | nullYes
unread_countintegerYes
windowobject | nullYes
created_atstringYes
assignee_idstring | nullYes
team_idstring | nullYes
assigned_atstring | nullYes
languagestring | nullYes
bot_activebooleanYes
last_seqintegerYes
visitor_last_read_seqintegerYes
visitor_last_delivered_seqintegerYes
agent_last_read_seqintegerYes
waiting_sincestring | nullYes
first_response_atstring | nullYes
sla_due_atstring | nullYes
resolved_atstring | nullYes
visitorobject | nullYes

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)

PATCH/v1/apps/{appId}/conversations/{conversationId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ConversationUpdateDto

FieldTypeRequiredDescription
statusenumYesValues: "open", "pending", "resolved", "closed"

Example:

{
  "status": "open"
}

Responses

200 — Success.

Schema: Conversation

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
statusenumYesValues: "open", "pending", "resolved", "closed"
subscription_idstring | nullYes
subscription_statusstring | nullYes
user_idstring | nullYes
external_idstring | nullYes
contactstringYes
opted_inbooleanYes
last_message_atstringYes
last_inbound_atstring | nullYes
last_directionenum | nullYes
last_message_previewstring | nullYes
unread_countintegerYes
windowobject | nullYes
created_atstringYes
assignee_idstring | nullYes
team_idstring | nullYes
assigned_atstring | nullYes
languagestring | nullYes
bot_activebooleanYes
last_seqintegerYes
visitor_last_read_seqintegerYes
visitor_last_delivered_seqintegerYes
agent_last_read_seqintegerYes
waiting_sincestring | nullYes
first_response_atstring | nullYes
sla_due_atstring | nullYes
resolved_atstring | nullYes
visitorobject | nullYes

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

GET/v1/apps/{appId}/conversations/{conversationId}/contactTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ConversationContact

FieldTypeRequiredDescription
userobject | nullYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].channelstringYes
subscriptions[].statusstringYes
subscriptions[].token_maskedstring | nullYes
subscriptions[].created_atstringYes
recent_eventsarray<object>Yes
recent_events[].namestringYes
recent_events[].occurred_atstringYes
recent_events[].propertiesmap<string, any>Yes
other_conversationsarray<object>Yes
other_conversations[].idstringYes
other_conversations[].channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
other_conversations[].statusenumYesValues: "open", "pending", "resolved", "closed"
other_conversations[].last_message_atstringYes

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)

GET/v1/apps/{appId}/conversations/{conversationId}/messagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
after_seqqueryintegerNoRange: 0–∞1
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ConversationMessagePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].directionenumYesValues: "inbound", "outbound"
data[].statusstringYes
data[].bodystring | nullYes
data[].contentmap<string, any>Yes
data[].message_idstring | nullYes
data[].delivery_idstring | nullYes
data[].sent_bystring | nullYes
data[].error_codestring | nullYes
data[].read_atstring | nullYes
data[].created_atstringYes
data[].seqintegerYes
data[].sender_typestringYes
data[].client_message_idstring | nullYes
data[].attachmentsarray<object>Yes
data[].attachments[].idstringYes
data[].attachments[].namestringYes
data[].attachments[].typestringYes
data[].attachments[].sizeintegerYes
data[].quick_repliesarray<object> | nullYes
next_cursorstring | nullYes
has_morebooleanYes

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).

POST/v1/apps/{appId}/conversations/{conversationId}/messagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ConversationReplyDto

FieldTypeRequiredDescription
textstringNoLength: 1–4096
templateobjectNo
template.namestringYes
template.languagestringYes
template.headerobjectNo
template.body_paramsarray<string>NoItems: 0–20
template.button_paramsarray<object>NoItems: 0–10
template.button_params[].indexintegerYesRange: 0–9
template.button_params[].sub_typeenumYesValues: "url", "quick_reply", "copy_code"
template.button_params[].valuestringYesLength: 1–256
mediaobjectNo
media.typeenumYesValues: "image", "video", "document", "audio"
media.urlstring (url)YesLength: 0–2000
media.filenamestringNoLength: 1–240
interactiveobjectNo
interactive.typeenumYesValues: "button", "list"
interactive.headerstringNoLength: 1–60
interactive.footerstringNoLength: 1–60
interactive.buttonsarray<object>NoItems: 1–3
interactive.buttons[].idstringYesLength: 1–256
interactive.buttons[].titlestringYesLength: 1–20
interactive.listobjectNo
interactive.list.buttonstringYesLength: 1–20
interactive.list.sectionsarray<object>YesItems: 1–10
interactive.list.sections[].titlestringNoLength: 1–24
interactive.list.sections[].rowsarray<object>YesItems: 1–10
interactive.list.sections[].rows[].idstringYesLength: 1–200
interactive.list.sections[].rows[].titlestringYesLength: 1–24
interactive.list.sections[].rows[].descriptionstringNoLength: 1–72
client_message_idstringNo
sourceenumNoValues: "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

FieldTypeRequiredDescription
message_idstring | nullYes
conversation_messageobjectYes
conversation_message.idstringYes
conversation_message.directionenumYesValues: "inbound", "outbound"
conversation_message.statusstringYes
conversation_message.bodystring | nullYes
conversation_message.contentmap<string, any>Yes
conversation_message.message_idstring | nullYes
conversation_message.delivery_idstring | nullYes
conversation_message.sent_bystring | nullYes
conversation_message.error_codestring | nullYes
conversation_message.read_atstring | nullYes
conversation_message.created_atstringYes
conversation_message.seqintegerYes
conversation_message.sender_typestringYes
conversation_message.client_message_idstring | nullYes
conversation_message.attachmentsarray<object>Yes
conversation_message.attachments[].idstringYes
conversation_message.attachments[].namestringYes
conversation_message.attachments[].typestringYes
conversation_message.attachments[].sizeintegerYes
conversation_message.quick_repliesarray<object> | nullYes

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)

POST/v1/apps/{appId}/conversations/{conversationId}/readTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Conversation

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
statusenumYesValues: "open", "pending", "resolved", "closed"
subscription_idstring | nullYes
subscription_statusstring | nullYes
user_idstring | nullYes
external_idstring | nullYes
contactstringYes
opted_inbooleanYes
last_message_atstringYes
last_inbound_atstring | nullYes
last_directionenum | nullYes
last_message_previewstring | nullYes
unread_countintegerYes
windowobject | nullYes
created_atstringYes
assignee_idstring | nullYes
team_idstring | nullYes
assigned_atstring | nullYes
languagestring | nullYes
bot_activebooleanYes
last_seqintegerYes
visitor_last_read_seqintegerYes
visitor_last_delivered_seqintegerYes
agent_last_read_seqintegerYes
waiting_sincestring | nullYes
first_response_atstring | nullYes
sla_due_atstring | nullYes
resolved_atstring | nullYes
visitorobject | nullYes

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)

POST/v1/apps/{appId}/conversations/{conversationId}/assignTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ConversationAssignDto

FieldTypeRequiredDescription
assignee_idstring | nullNo
team_idstring | nullNo

Example:

{
  "assignee_id": "cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "team_id": "itm_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: Conversation

FieldTypeRequiredDescription
idstringYes
channelenumYesValues: "sms", "whatsapp", "rcs", "telegram", "viber", "email", "chat"
statusenumYesValues: "open", "pending", "resolved", "closed"
subscription_idstring | nullYes
subscription_statusstring | nullYes
user_idstring | nullYes
external_idstring | nullYes
contactstringYes
opted_inbooleanYes
last_message_atstringYes
last_inbound_atstring | nullYes
last_directionenum | nullYes
last_message_previewstring | nullYes
unread_countintegerYes
windowobject | nullYes
created_atstringYes
assignee_idstring | nullYes
team_idstring | nullYes
assigned_atstring | nullYes
languagestring | nullYes
bot_activebooleanYes
last_seqintegerYes
visitor_last_read_seqintegerYes
visitor_last_delivered_seqintegerYes
agent_last_read_seqintegerYes
waiting_sincestring | nullYes
first_response_atstring | nullYes
sla_due_atstring | nullYes
resolved_atstring | nullYes
visitorobject | nullYes

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

POST/v1/apps/{appId}/conversations/{conversationId}/tagsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ConversationTagsDto

FieldTypeRequiredDescription
addmap<string, string>No
removearray<string>NoItems: 0–50

Example:

{
  "add": {
    "key": "user_42"
  },
  "remove": [
    "örnek"
  ]
}

Responses

200 — Success.

Schema: ConversationTagsResult

FieldTypeRequiredDescription
user_idstringYes
tagsmap<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)

GET/v1/apps/{appId}/conversations/{conversationId}/activityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
conversationIdpathstringYes"cvs_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: ConversationActivity

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].typestringYes
data[].actor_typestringYes
data[].actor_idstring | nullYes
data[].datamap<string, any>Yes
data[].created_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SmsKeywordList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].keywordstringYes
data[].scopeenumYesValues: "org", "app"
data[].app_idstring | nullYes
data[].channelsarray<enum>Yes
data[].actionsmap<string, any>Yes
data[].enabledbooleanYes
data[].descriptionstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
reservedarray<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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateKeywordDto

FieldTypeRequiredDescription
keywordstringYesLength: 1–30
scopeenumNoValues: "org", "app"
channelsarray<enum>NoItems: 1–3
actionsobjectYes
actions.add_tagsmap<string, string>No
actions.remove_tagsarray<string>NoItems: 0–50
actions.eventobjectNo
actions.event.namestringYes
actions.event.propertiesmap<string, string>No
actions.replyobjectNo
actions.reply.textstringYesLength: 1–1600
actions.opt_inbooleanNo
enabledbooleanNo
descriptionstringNoLength: 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

FieldTypeRequiredDescription
idstringYes
keywordstringYes
scopeenumYesValues: "org", "app"
app_idstring | nullYes
channelsarray<enum>Yes
actionsmap<string, any>Yes
enabledbooleanYes
descriptionstring | nullYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/sms-keywords/{keywordId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
keywordIdpathstringYes"smk_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateKeywordDto

FieldTypeRequiredDescription
keywordstringNoLength: 1–30
channelsarray<enum>NoItems: 1–3
actionsobjectNo
actions.add_tagsmap<string, string>No
actions.remove_tagsarray<string>NoItems: 0–50
actions.eventobjectNo
actions.event.namestringYes
actions.event.propertiesmap<string, string>No
actions.replyobjectNo
actions.reply.textstringYesLength: 1–1600
actions.opt_inbooleanNo
enabledbooleanNo
descriptionstring | nullNo

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

FieldTypeRequiredDescription
idstringYes
keywordstringYes
scopeenumYesValues: "org", "app"
app_idstring | nullYes
channelsarray<enum>Yes
actionsmap<string, any>Yes
enabledbooleanYes
descriptionstring | nullYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/sms-keywords/{keywordId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
keywordIdpathstringYes"smk_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/sms-keywords/smk_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

WhatsApp templates (with Meta approval status)

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

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

Parameters

NameInTypeRequiredDescriptionExample
statusquerystringNoLength: 0–30"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WhatsAppTemplateList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].external_idstring | nullYes
data[].namestringYes
data[].languagestringYes
data[].categorystringYes
data[].statusstringYes
data[].componentsarray<map<string, any>>Yes
data[].body_paramsintegerYes
data[].rejected_reasonstring | nullYes
data[].quality_scorestring | nullYes
data[].synced_atstringYes

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

POST/v1/apps/{appId}/whatsapp/templates/syncTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WhatsAppTemplateSync

FieldTypeRequiredDescription
totalintegerYes
removedintegerYes
dataarray<object>Yes
data[].idstringYes
data[].external_idstring | nullYes
data[].namestringYes
data[].languagestringYes
data[].categorystringYes
data[].statusstringYes
data[].componentsarray<map<string, any>>Yes
data[].body_paramsintegerYes
data[].rejected_reasonstring | nullYes
data[].quality_scorestring | nullYes
data[].synced_atstringYes

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"

On this page

OperationsDetailsAI agents200 — Success.Create an AI agent201 — Success.AI agent runs200 — Success.AI agent200 — Success.Update an AI agent200 — Success.Delete an AI agent204 — Success.Rotate the tool signing secret200 — Success.AI agent metrics (last 30 days)200 — Success.Conversations (SMS, WhatsApp, RCS, email, live chat; ordered by last message; channel/status/unread/assignee/team/contact filters)200 — Success.Conversation (including assignment, SLA, bot status, WhatsApp session window and opt-in)200 — Success.Conversation status: open / pending / resolved (closed = resolved)200 — Success.Contact profile: properties, tags, subscriptions (masked), recent events and other conversations200 — Success.Conversation messages (newest first; oldest first with after_seq; outbound message status comes from the delivery or the read receipt)200 — Success.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).202 — Success.Mark inbound messages as read (in chat, a read receipt is sent to the visitor)200 — Success.Assign the conversation to an agent and/or team (without inbox.manage, only to yourself)200 — Success.Add/remove a tag on the contact from the chat200 — Success.Conversation timeline (assignment, status, first response, bot handoff)200 — Success.Two-way messaging keywords (org-wide + this app) and legal (reserved) keywords200 — Success.Create a keyword (add/remove tag, event → journey trigger, auto-reply, subscription)201 — Success.Update a keyword200 — Success.Delete a keyword200 — Success.WhatsApp templates (with Meta approval status)200 — Success.Sync WhatsApp templates from the Meta Graph API200 — Success.