live-chat

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

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

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението 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, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}