live-chat

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

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

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin livechat.manage; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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	Wajib	Tentang apa ini
`widgetId (path)`	`string`	Ya	—

Isi permintaan

Nama	Jenis	Wajib	Tentang apa ini
`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	—

Tanggapan

Nama	Jenis	Wajib	Tentang apa ini
`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.

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}