live-chat

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

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

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये livechat.manage परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

या एंडपॉइंटला कोणतीही संस्था आयडी (organisation id) लागत नाही. तुमची की (key) आधीच ती कोणत्या संस्थेशी संबंधित आहे हे ओळखते आणि प्रतिसाद त्यानुसार मर्यादित केला जातो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि key प्लेसहोल्डरला तुमच्या डॅशबोर्डवरील किने बदला.

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

साइन इन केलेले आहे? तुमच्या डॅशबोर्डमधील 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 for…
`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…
`tier`	`string`	होय	The tier this widget is EFFECTIVELY on. Premium is included free with Zinn® hosting, so this may read `premium` on a widget nobody has paid for — read `purchased_tier` for what…
`tier_source`	`string<free, purchase, hosting>`	होय	Why the widget is on that tier. `hosting` means it is included with the customer's Zinn® hosting and there is nothing to buy; `purchase` means the Premium extra was bought for…
`purchased_tier`	`string`	होय	The tier actually PAID for, independent of any hosting inclusion.
`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}