live-chat

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

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

Autenticazione

Invia una chiave API come token di tipo bearer. La chiave deve disporre dell'autorizzazione livechat.manage; una chiave sprovvista di tale autorizzazione viene rifiutata con 403 anziché 404.

Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.

Provalo

Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.

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

Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API

Dettagli

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.

Parametri

Nome	Tipo	Obbligatorio	Che cos'è
`widgetId (path)`	`string`	Sì	—

Corpo della richiesta

Nome	Tipo	Obbligatorio	Che cos'è
`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	—

Risposta

Nome	Tipo	Obbligatorio	Che cos'è
`id`	`string`	Sì	—
`site_id`	`string`	Sì	—
`name`	`string`	Sì	—
`public_key`	`string`	Sì	—
`enabled`	`boolean`	Sì	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[]`	Sì	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`	Sì	—
`greeting`	`string`	Sì	—
`team_name`	`string`	Sì	—
`accent_colour`	`string`	Sì	—
`position`	`string<left, right>`	Sì	—
`hide_branding`	`boolean`	Sì	—
`ai_enabled`	`boolean`	Sì	—
`offline_email`	`string`	Sì	—
`business_hours`	`object`	No	—
`open_now`	`boolean`	Sì	—
`ai_allowance`	`ChatAiAllowance`	Sì	—
`limits`	`object`	Sì	—
`premium_extra_code`	`string`	Sì	The catalogue code to buy for the premium tier.

Errori che questo endpoint può restituire

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}