Skip to main content
POST
Create web widget

Body

application/json
assistant_id
string<uuid>
required

Assistant that answers voice and chat from this widget. Translate assistants are rejected with 422, because they only run in translation rooms.

name
string
required
allowed_origins
string[]

Optional site origins that may embed the widget (e.g. https://example.com). Empty or omitted blocks third-party hosts.

voice_enabled
boolean
chat_enabled
boolean
is_active
boolean
theme
object

Widget appearance. On create and update the theme object replaces the saved theme as a whole — read the widget first (get) and send the complete theme with your change, otherwise omitted settings return to their defaults. launcher_label_i18n and greeting_translations are derived and read-only — never persist client-supplied maps.

phone_verification_enabled
boolean
default:false

Require the selected email or SMS verification before chat or voice. Available in root workspaces, including a reseller’s own workspace; unavailable to reseller customer workspaces.

phone_verification_accepted_credits
number | null

Explicitly accept the current per-SMS price from the widget list response. Currently 80 credits per accepted send, including resends; code checks and valid remembered visits are free.

verification_method
enum<string>
default:sms

Verify visitors by SMS or email. Email uses the platform sender without additional credits.

Available options:
sms,
email

Response

Created widget.

data
object
required