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}