live-chat

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

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

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) livechat.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

Név	Típus	Kötelező	Mi ez
`widgetId (path)`	`string`	Igen	—

Kérés törzse

Név	Típus	Kötelező	Mi ez
`name`	`string`	Nem	—
`enabled`	`boolean`	Nem	—
`allowed_origins`	`string[]`	Nem	—
`greeting`	`string`	Nem	—
`team_name`	`string`	Nem	—
`accent_colour`	`string`	Nem	—
`position`	`string<left, right>`	Nem	—
`hide_branding`	`boolean`	Nem	—
`ai_enabled`	`boolean`	Nem	—
`offline_email`	`string`	Nem	—
`business_hours`	`object`	Nem	—

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`site_id`	`string`	Igen	—
`name`	`string`	Igen	—
`public_key`	`string`	Igen	—
`enabled`	`boolean`	Igen	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[]`	Igen	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`	Igen	—
`greeting`	`string`	Igen	—
`team_name`	`string`	Igen	—
`accent_colour`	`string`	Igen	—
`position`	`string<left, right>`	Igen	—
`hide_branding`	`boolean`	Igen	—
`ai_enabled`	`boolean`	Igen	—
`offline_email`	`string`	Igen	—
`business_hours`	`object`	Nem	—
`open_now`	`boolean`	Igen	—
`ai_allowance`	`ChatAiAllowance`	Igen	—
`limits`	`object`	Igen	—
`premium_extra_code`	`string`	Igen	The catalogue code to buy for the premium tier.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}