live-chat

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

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

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 livechat.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

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.

매개변수

이름	유형	필수	설명
`widgetId (path)`	`string`	예	—

요청 본문

이름	유형	필수	설명
`name`	`string`	아니요	—
`enabled`	`boolean`	아니요	—
`allowed_origins`	`string[]`	아니요	—
`greeting`	`string`	아니요	—
`team_name`	`string`	아니요	—
`accent_colour`	`string`	아니요	—
`position`	`string<left, right>`	아니요	—
`hide_branding`	`boolean`	아니요	—
`ai_enabled`	`boolean`	아니요	—
`offline_email`	`string`	아니요	—
`business_hours`	`object`	아니요	—

응답

이름	유형	필수	설명
`id`	`string`	예	—
`site_id`	`string`	예	—
`name`	`string`	예	—
`public_key`	`string`	예	—
`enabled`	`boolean`	예	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[]`	예	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`	예	—
`greeting`	`string`	예	—
`team_name`	`string`	예	—
`accent_colour`	`string`	예	—
`position`	`string<left, right>`	예	—
`hide_branding`	`boolean`	예	—
`ai_enabled`	`boolean`	예	—
`offline_email`	`string`	예	—
`business_hours`	`object`	아니요	—
`open_now`	`boolean`	예	—
`ai_allowance`	`ChatAiAllowance`	예	—
`limits`	`object`	예	—
`premium_extra_code`	`string`	예	The catalogue code to buy for the premium tier.

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 422

PATCH /v1/chat/widgets/{widgetId}

인증