POST /v1/chat/widgets/{widgetId}/copy-settings

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 POST https://api.zinndigital.com/v1/chat/widgets/{widgetId}/copy-settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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 on this chat and livechat.manage on every target. Copies the colour, position, team name, greeting, logo, opening hours, the "hide Zinn® Chat branding" choice and this chat's own saved replies (a mirror: replies the target has and this chat does not are removed). Never copies the public key, the allowed web addresses, the on/off switch, the name, the missed-chat email address, the AI switch, the tier or any conversation. A site with no chat gets one, created switched off with no web addresses. With dry_run the full diff is returned and nothing is written. At most 100 targets per request — a page, not a limit on the work: send the rest in the next request. A target outside the organisations you manage answers 404, and nothing is changed.

Parameters

Request body

Response

Errors this endpoint can return

401 · 403 · 404 · 422