live-chat

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

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

Pengesahan

Hantar kunci API sebagai token pembawa. Kunci tersebut mesti membawa kebenaran livechat.manage; kunci yang tidak mempunyainya akan ditolak dengan 403, bukan 404.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`widgetId (path)`	`string`	Ya	—

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`name`	`string`	Tidak	—
`enabled`	`boolean`	Tidak	—
`allowed_origins`	`string[]`	Tidak	—
`greeting`	`string`	Tidak	—
`team_name`	`string`	Tidak	—
`accent_colour`	`string`	Tidak	—
`position`	`string<left, right>`	Tidak	—
`hide_branding`	`boolean`	Tidak	—
`ai_enabled`	`boolean`	Tidak	—
`offline_email`	`string`	Tidak	—
`business_hours`	`object`	Tidak	—

Respons

Nama	Jenis	Diperlukan	Apakah ia
`id`	`string`	Ya	—
`site_id`	`string`	Ya	—
`name`	`string`	Ya	—
`public_key`	`string`	Ya	—
`enabled`	`boolean`	Ya	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[]`	Ya	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`	Ya	—
`greeting`	`string`	Ya	—
`team_name`	`string`	Ya	—
`accent_colour`	`string`	Ya	—
`position`	`string<left, right>`	Ya	—
`hide_branding`	`boolean`	Ya	—
`ai_enabled`	`boolean`	Ya	—
`offline_email`	`string`	Ya	—
`business_hours`	`object`	Tidak	—
`open_now`	`boolean`	Ya	—
`ai_allowance`	`ChatAiAllowance`	Ya	—
`limits`	`object`	Ya	—
`premium_extra_code`	`string`	Ya	The catalogue code to buy for the premium tier.

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}