live-chat
POST /v1/chat/conversations/{conversationId}/close
Close a conversation.
Authentication
Send an API key as a bearer token. The key must carry the livechat.reply permission; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/close \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
Requires livechat.reply. Idempotent. A visitor who writes again reopens it rather than being told the conversation is over.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
conversationId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | — |
widget_id | string | Yes | — |
state | string<ai, waiting, open, offline, closed> | Yes | — |
visitor_name | string | Yes | — |
visitor_email | string | Yes | — |
page_url | string | Yes | — |
page_title | string | Yes | — |
referrer | string | Yes | — |
country | string | Yes | Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored. |
locale | string | Yes | — |
assigned_operator | string | Yes | — |
cursor | integer | Yes | — |
started_at | string | Yes | — |
last_message_at | string | Yes | — |
Errors this endpoint can return
401 · 403 · 404