live-chat
POST /v1/chat/widgets/{widgetId}/settings-import
Apply a settings file to this chat.
Authentication
Send an API key as a bearer token. The key must carry the livechat.manage 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/widgets/{widgetId}/settings-import \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "format": <string<zinn-chat-settings>>, "version": <integer>, "settings": <object> }'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.manage. The file is validated in full — an unknown format, a newer version, a missing key, a malformed colour or opening hours, a duplicate saved reply or a logo that does not match its fingerprint answers 422 and changes nothing. With dry_run=true the diff is returned and nothing is written.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
widgetId (path) | string | Yes | — |
dry_run (query) | boolean | No | — |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
format | string<zinn-chat-settings> | Yes | — |
version | integer | Yes | — |
settings | object | Yes | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
widget_id | string | Yes | Null only for a chat a dry run would create. |
site_id | string | Yes | — |
name | string | Yes | — |
created | boolean | Yes | — |
applied | boolean | Yes | — |
tier | string | Yes | — |
changes | ChatSettingsChange[] | Yes | — |
waiting_for_premium | string<business_hours, hide_branding, logo>[] | Yes | Changed settings that are stored on this chat and shown to visitors only once it is on Premium. |
Errors this endpoint can return
401 · 403 · 404 · 422