live-chat

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

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

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл livechat.manage; ключ без нього відхиляється з кодом 403, а не 404.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X PATCH https://api.zinndigital.com/v1/chat/widgets/{widgetId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Деталі

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.

Параметри

Назва	Тип	Обов'язкове	Що це таке
`widgetId (path)`	`string`	Так	—

Тіло запиту

Назва	Тип	Обов'язкове	Що це таке
`name`	`string`	Ні	—
`enabled`	`boolean`	Ні	—
`allowed_origins`	`string[]`	Ні	—
`greeting`	`string`	Ні	—
`team_name`	`string`	Ні	—
`accent_colour`	`string`	Ні	—
`position`	`string<left, right>`	Ні	—
`hide_branding`	`boolean`	Ні	—
`ai_enabled`	`boolean`	Ні	—
`offline_email`	`string`	Ні	—
`business_hours`	`object`	Ні	—

Відповідь

Назва	Тип	Обов'язкове	Що це таке
`id`	`string`	Так	—
`site_id`	`string`	Так	—
`name`	`string`	Так	—
`public_key`	`string`	Так	—
`enabled`	`boolean`	Так	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[]`	Так	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`	Так	—
`greeting`	`string`	Так	—
`team_name`	`string`	Так	—
`accent_colour`	`string`	Так	—
`position`	`string<left, right>`	Так	—
`hide_branding`	`boolean`	Так	—
`ai_enabled`	`boolean`	Так	—
`offline_email`	`string`	Так	—
`business_hours`	`object`	Ні	—
`open_now`	`boolean`	Так	—
`ai_allowance`	`ChatAiAllowance`	Так	—
`limits`	`object`	Так	—
`premium_extra_code`	`string`	Так	The catalogue code to buy for the premium tier.

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}