Create Chat Widget
Create an additional chat widget for the current customer.
New widgets are never the default; the default is the customer's original widget (created on first legacy update, or promoted via update).
Request body
Whether the chat widget is shown on the customer's website
Primary color hex code (e.g., #B5683C)
Secondary accent color hex code. Set to null to auto-derive from accent color.
Widget position: bottom-right or bottom-left
The first message shown when a visitor opens the chat
Displayed in the chat header
Full system prompt override. Set to null to use assembled prompt from structured fields.
Personality/tone instructions
Firm-specific information. Set to null to fall back to Customer.law_firm_info_prompt.
What to do after collecting info
Extra rules or context
Whether to show a teaser message bubble
Teaser message text
Seconds before teaser appears
Whether to show online indicator
Whether to show unread badge on bubble
Whether to flash unread count in tab title
URL of agent avatar image
URL of a silent looping video shown in place of the avatar image (header and launcher). Takes precedence over avatar_url.
When false, the open panel's header shows the static avatar image and the avatar video only plays on the launcher bubble
When true (and avatar_url is set), the floating launcher shows the avatar image inside an accent-colored ring instead of the default chat bubble icon
When true (and intro_video_url is set), opening the widget plays an intro video full-panel before transitioning into the chat
URL of the intro video (mp4/webm) played when the widget opens
When true, desktop visitors see the muted intro video playing in the widget corner on page load; when false it only plays after they click the launcher
When true, a full-page modal asks visitors if they need help; Yes opens the chat directly, No dismisses it
Question shown in the attention grabber modal
Seconds before the attention grabber modal appears (1-120)
Message shown when visitor is idle
Seconds of inactivity before nudge (10-300)
Privacy Quick Exit: the widget never persists the chat across page loads — the conversation is ended and reset on browser close/refresh
Extra clearance in pixels between the widget and the bottom of the viewport on mobile (0-300). Null = none.
Minutes of inactivity before auto-completing a chat (1-60). Default: 10 minutes.
Allowed origins for CORS. When empty or null, any origin can embed the widget.
Display label for the widget (e.g. which website it serves)
Response
Successful Response
Whether the chat widget is shown on the customer's website
Primary color for the bubble, header, and assistant messages
Secondary accent color. When null, derived automatically from the accent color.
Where the chat bubble appears on the page (bottom-right or bottom-left)
The first message shown when a visitor opens the chat
Displayed in the chat header
Full system prompt override. When set, replaces the assembled prompt entirely.
Personality/tone instructions (e.g. 'You are Ashley, a warm and professional intake specialist')
Firm-specific information injected into the prompt. Falls back to Customer.law_firm_info_prompt if not set.
What to do after collecting info (e.g. 'Let them know an attorney will follow up within 24 hours')
Extra rules or context for the AI assistant
Whether to show a teaser message bubble next to the chat button
Teaser message text. Falls back to greeting_message if not set.
Seconds to wait before showing the teaser message
Whether to show an online indicator on the chat bubble and header
Whether to show an unread badge on the chat bubble
Whether to flash unread count in the browser tab title
URL of the agent avatar image for the header and messages
URL of a silent looping video shown in place of the avatar image (header and launcher). Takes precedence over avatar_url.
When false, the open panel's header shows the static avatar image and the avatar video only plays on the launcher bubble
When true (and avatar_url is set), the floating launcher shows the avatar image inside an accent-colored ring instead of the default chat bubble icon
When true (and intro_video_url is set), opening the widget plays an intro video full-panel before transitioning into the chat
URL of the intro video (mp4/webm) played when the widget opens
When true, desktop visitors see the muted intro video playing in the widget corner on page load; when false it only plays after they click the launcher
When true, a full-page modal asks visitors if they need help; Yes opens the chat directly, No dismisses it
Question shown in the attention grabber modal. Falls back to a default when not set.
Seconds to wait before showing the attention grabber modal
Message shown when visitor is idle. Leave empty to disable.
Seconds of inactivity before showing the idle nudge message
Privacy Quick Exit: the widget never persists the chat across page loads — the conversation is ended and reset on browser close/refresh
Extra clearance in pixels between the widget and the bottom of the viewport on mobile, for sites with a fixed bottom bar. Null = none.
Minutes of inactivity before a chat is auto-completed. Default: 10 minutes.
Allowed origins for CORS. When empty or null, any origin can embed the widget.
Display label for the widget
Whether this is the customer's default widget
Changes
No recorded changes to this endpoint across all 1 revision of this API.