live-chat

POST `/v1/chat/widgets/{widgetId}/settings-import`

Apply a settings file to this chat.

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу livechat.manage; кључ без ње се одбија уз 403, а не 404.

Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

curl -X POST https://api.zinndigital.com/v1/chat/widgets/{widgetId}/settings-import \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "format": <string<zinn-chat-settings>>, "version": <integer>, "settings": <object> }'

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

Requires livechat.manage. The file is validated in full — an unknown format, a newer version, a missing key, a malformed colour or opening hours, a duplicate saved reply or a logo that does not match its fingerprint answers 422 and changes nothing. With dry_run=true the diff is returned and nothing is written.

Параметри

Назив	Тип	Обавезно	Шта је ово
`widgetId (path)`	`string`	Да	—
`dry_run (query)`	`boolean`	Не	—

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`format`	`string<zinn-chat-settings>`	Да	—
`version`	`integer`	Да	—
`settings`	`object`	Да	—

Одговор

Назив	Тип	Обавезно	Шта је ово
`widget_id`	`string`	Да	Null only for a chat a dry run would create.
`site_id`	`string`	Да	—
`name`	`string`	Да	—
`created`	`boolean`	Да	—
`applied`	`boolean`	Да	—
`tier`	`string`	Да	—
`changes`	`ChatSettingsChange[]`	Да	—
`waiting_for_premium`	`string<business_hours, hide_branding, logo>[]`	Да	Changed settings that are stored on this chat and shown to visitors only once it is on Premium.

Грешке које ова крајња тачка може вратити

401 · 403 · 404 · 422

POST /v1/chat/widgets/{widgetId}/settings-import