live-chat
GET /v1/chat/widgets/{widgetId}/settings-export
Download this chat's portable settings as a file.
Authentication
Send an API key as a bearer token. The key must carry the livechat.view 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 GET https://api.zinndigital.com/v1/chat/widgets/{widgetId}/settings-export \
-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.view or livechat.manage. The same set the copy moves, with the logo carried as its own bytes. Canonical — keys sorted, no ids, no timestamps — so an export, imported elsewhere and exported again, is byte-for-byte the same file. Served with Content-Disposition: attachment.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
widgetId (path) | string | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
format | string<zinn-chat-settings> | Yes | — |
version | integer | Yes | — |
settings | object | Yes | — |
Errors this endpoint can return
401 · 403 · 404