live-chat

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

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

प्रमाणन

बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास livechat.manage अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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

साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव 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}