live-chat

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

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

Pagpapatotoo

Magpadala ng API key bilang isang bearer token. Kailangang taglayin ng key ang pahintulot na livechat.manage; ang key na wala nito ay tatanggihan gamit ang 403, hindi 404.

Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`widgetId (path)`	`string`	Oo	—

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`name`	`string`	Hindi	—
`enabled`	`boolean`	Hindi	—
`allowed_origins`	`string[]`	Hindi	—
`greeting`	`string`	Hindi	—
`team_name`	`string`	Hindi	—
`accent_colour`	`string`	Hindi	—
`position`	`string<left, right>`	Hindi	—
`hide_branding`	`boolean`	Hindi	—
`ai_enabled`	`boolean`	Hindi	—
`offline_email`	`string`	Hindi	—
`business_hours`	`object`	Hindi	—

Tugon

Pangalan	Uri	Kailangan	Ano ito
`id`	`string`	Oo	—
`site_id`	`string`	Oo	—
`name`	`string`	Oo	—
`public_key`	`string`	Oo	—
`enabled`	`boolean`	Oo	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[]`	Oo	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`	Oo	—
`greeting`	`string`	Oo	—
`team_name`	`string`	Oo	—
`accent_colour`	`string`	Oo	—
`position`	`string<left, right>`	Oo	—
`hide_branding`	`boolean`	Oo	—
`ai_enabled`	`boolean`	Oo	—
`offline_email`	`string`	Oo	—
`business_hours`	`object`	Hindi	—
`open_now`	`boolean`	Oo	—
`ai_allowance`	`ChatAiAllowance`	Oo	—
`limits`	`object`	Oo	—
`premium_extra_code`	`string`	Oo	The catalogue code to buy for the premium tier.

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}