live-chat

PATCH `/v1/chat/widgets/{widgetId}`

Change a chat's settings, or switch it on.

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 PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -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.manage`. Switching a widget on with no `allowedOrigins` is refused with `422` rather than accepted: the widget only answers pages on origins the customer listed, so an empty list would leave the chat live, looking configured, and invisible on every page with nothing saying why.

Parameters

Name	Type	Required	What it is
`widgetId (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`name`	`string`	No	—
`enabled`	`boolean`	No	—
`allowed_origins`	`string[]`	No	—
`greeting`	`string`	No	—
`team_name`	`string`	No	—
`accent_colour`	`string`	No	—
`position`	`string<left, right>`	No	—
`hide_branding`	`boolean`	No	—
`ai_enabled`	`boolean`	No	—
`offline_email`	`string`	No	—
`business_hours`	`object`	No	—

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`site_id`	`string`	Yes	—
`name`	`string`	Yes	—
`public_key`	`string`	Yes	—
`enabled`	`boolean`	Yes	Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked fo…
`allowed_origins`	`string[]`	Yes	Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations a…
`tier`	`string`	Yes	—
`greeting`	`string`	Yes	—
`team_name`	`string`	Yes	—
`accent_colour`	`string`	Yes	—
`position`	`string<left, right>`	Yes	—
`hide_branding`	`boolean`	Yes	—
`ai_enabled`	`boolean`	Yes	—
`offline_email`	`string`	Yes	—
`business_hours`	`object`	No	—
`open_now`	`boolean`	Yes	—
`ai_allowance`	`ChatAiAllowance`	Yes	—
`limits`	`object`	Yes	—
`premium_extra_code`	`string`	Yes	The catalogue code to buy for the premium tier.

Errors this endpoint can return

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}