← Chat widget operations · All schemas
Clone Chat Widget — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
chatWidgetId | string | Required within parent | chat widget ID |
locationId | string | Required within parent | locationId |
name | string | Optional | Name for the cloned widget |
Create Chat Widget — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
chatType | string | Required within parent | Chat type
One of: liveChat, emailChat |
default | boolean | Optional | Default |
deleted | boolean | Optional | Deleted |
locationId | string | Required within parent | Location ID |
name | string | Required within parent | Name |
settings | JSON | Optional | Settings |
settings (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color |
version | number | Required within parent | Version |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color
Patch Chat Widget — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
chatType | string | Optional | Chat type
One of: liveChat, emailChat |
default | boolean | Optional | Default |
name | string | Optional | Name |
settings | JSON | Optional | Settings |
settings (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color |
version | number | Optional | Version |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
acknowledgementDetails | JSON | Optional | Acknowledgement Details |
acknowledgementDetails (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color acknowledgement Details icon, live Chat Icon, live Chat Placeholder Color, placeholder Color |
advanceSettings | JSON | Optional | Advance Settings |
advanceSettings (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text |
agencyName | string | Optional | Name of the agency |
agencyWebsite | string | Optional | Website URL of the agency |
allowAvatarImage | boolean | Optional | Allow avatar image |
autoCountryCode | boolean | Optional | Boolean indicating whether to automatically detect country code |
chatIcon | string | Required within parent | Message Chat Circle |
chatType | string | Required within parent | Chat Type |
countryCode | string | Optional | Country code |
dimensions | JSON | Optional | Customizations |
dimensions (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes |
enableRevisitMessage | boolean | Optional | Boolean indicating whether to enable a revisit message |
heading | string | Optional | Heading text |
isPromptAvatarImageOptimize | boolean | Optional | Avatar Image Optimization |
legalMsg | string | Optional | Legal message |
liveChatAckMsg | string | Optional | Message acknowledging a live chat |
liveChatEndedMsg | string | Optional | Message indicating the end of a live chat |
liveChatFeedbackMsg | string | Optional | Message asking for feedback after a live chat |
liveChatFeedbackNote | string | Optional | Note regarding live chat feedback |
liveChatIntroMsg | string | Optional | Introduction message for a live chat |
liveChatUserInactiveMsg | string | Optional | Message for inactive users during a live chat |
liveChatUserInactiveTime | string | Optional | Time for considering a user inactive during a live chat |
liveChatVisitorInactiveMsg | string | Optional | Message for inactive visitors during a live chat |
liveChatVisitorInactiveTime | string | Optional | Time for considering a visitor inactive during a live chat |
locale | string | Optional | Locale setting |
locationCountryCode | string | Optional | Location Country Code |
promptAvatar | string | Optional | Avatar for prompts |
promptAvatarAltText | string | Optional | Prompt Avatar Alt Text |
promptMsg | string | Optional | Prompt message |
promptType | string | Optional | Prompt Type |
representativeAssignedMessage | string | Optional | Representative Assigned Message |
revisitPromptMsg | string | Optional | Message for revisiting prompts |
sendActionText | string | Optional | Text for send action |
showAgencyBranding | boolean | Optional | Boolean indicating whether to show agency branding |
showConsentCheckbox | boolean | Optional | Boolean indicating whether to show a consent checkbox |
showLiveChatWelcomeMsg | boolean | Optional | Boolean indicating whether to show a welcome message for live chat |
showPrompt | boolean | Optional | Boolean indicating whether to show prompts |
subHeading | string | Optional | Subheading text |
successMsg | string | Optional | Success message |
supportContact | string | Optional | Contact information for support |
thankYouMsg | string | Optional | Thank you message |
theme | JSON | Optional | Theme |
theme (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name |
useEmailField | boolean | Optional | Boolean indicating whether to use an email field |
waNumber | string | Optional | WhatsApp number |
widgetId | string | Optional | Widget Id |
widgetPlacement | string | Optional | Widget Placement |
widgetPrimaryColor | string | Optional | Primary color for the widget |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color acknowledgement Details icon, live Chat Icon, live Chat Placeholder Color, placeholder Color, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color acknowledgement Details icon, live Chat Icon, live Chat Placeholder Color, placeholder Color
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
icon | string | Optional | Icon |
liveChatIcon | string | Optional | Icon for live chat |
liveChatPlaceholderColor | string | Optional | Placeholder color for live chat |
placeholderColor | string | Optional | Placeholder color |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
aTwoPCompliance | JSON | Optional | A2P Compliance |
aTwoPCompliance (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text a Two P Compliance a2p Opt In Form1, a2p Opt In Form1 Pre Checked, a2p Opt In Form1 Show Checkbox, a2p Opt In Form2, a2p Opt In Form2 Pre Checked, a2p Opt In Form2 Show Checkbox, enable A2 P Compliance, is A2 P Opt In Form1, is A2 P Opt In Form2, message Type, privacy Policy Link, terms Of Service Link |
allInOneChatTypes | array | Optional | Chat types included in the all-in-one widget |
allInOneChatTypes[] | string | Each item | One of: liveChat, waChat, emailChat, allInOneChat, voiceAiChat, facebookChat, instagramChat, webChat |
allInOneInitialMsg | string | Optional | All In One Initial Msg |
brandingTitle | string | Optional | Branding Title |
businessOfficeHours | JSON | Optional | Business Office Hours |
businessOfficeHours (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text business Office Hours enable Business Hours, open Hours, outside Office Hours Welcome Msg, timezone |
contactFormIntroMessage | string | Optional | Contact Form Intro Message |
contactFormOptions | array | Optional | Contact form field configuration |
contactFormOptions[] | string | Each item | |
contactFormSystemMessage | string | Optional | Contact Form System Message |
defaultConsentCheck | boolean | Optional | By default consent check for contact form |
enableContactForm | boolean | Optional | Boolean for showing contact form at start |
fbPage | JSON | Optional | Facebook Page |
fbPage (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text fb Page facebook Page Id, facebook Page Name |
instagramPage | JSON | Optional | Instagram Page |
instagramPage (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text instagram Page facebook Page Id, facebook Page Name, instagram Page Id, instagram Username |
playNotificationSound | boolean | Optional | Play Notification Sound |
prefilledMessageText | string | Optional | Prefilled Message Text |
redirect | JSON | Optional | Redirect Object |
redirect (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text redirect redirect Action, redirect Text, redirect Website |
voiceAiAgent | object | Optional | Voice AI Agent |
voiceAiSendActionText | string | Optional | Voice Ai Send Action Text |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text a Two P Compliance a2p Opt In Form1, a2p Opt In Form1 Pre Checked, a2p Opt In Form1 Show Checkbox, a2p Opt In Form2, a2p Opt In Form2 Pre Checked, a2p Opt In Form2 Show Checkbox, enable A2 P Compliance, is A2 P Opt In Form1, is A2 P Opt In Form2, message Type, privacy Policy Link, terms Of Service Link, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text business Office Hours enable Business Hours, open Hours, outside Office Hours Welcome Msg, timezone, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text fb Page facebook Page Id, facebook Page Name, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text instagram Page facebook Page Id, facebook Page Name, instagram Page Id, instagram Username, Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text redirect redirect Action, redirect Text, redirect Website
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text a Two P Compliance a2p Opt In Form1, a2p Opt In Form1 Pre Checked, a2p Opt In Form1 Show Checkbox, a2p Opt In Form2, a2p Opt In Form2 Pre Checked, a2p Opt In Form2 Show Checkbox, enable A2 P Compliance, is A2 P Opt In Form1, is A2 P Opt In Form2, message Type, privacy Policy Link, terms Of Service Link
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
a2pOptInForm1 | string | Optional | A2P Opt In Form 1 |
a2pOptInForm1PreChecked | boolean | Optional | Pre-checked state for A2P Opt In Form 1 checkbox |
a2pOptInForm1ShowCheckbox | boolean | Optional | Show checkbox for A2P Opt In Form 1 |
a2pOptInForm2 | string | Optional | A2P Opt In Form 2 |
a2pOptInForm2PreChecked | boolean | Optional | Pre-checked state for A2P Opt In Form 2 checkbox |
a2pOptInForm2ShowCheckbox | boolean | Optional | Show checkbox for A2P Opt In Form 2 |
enableA2PCompliance | boolean | Optional | Enable A2P Compliance |
isA2POptInForm1 | boolean | Optional | Is A2P Opt In Form 1 enabled |
isA2POptInForm2 | boolean | Optional | Is A2P Opt In Form 2 |
messageType | string | Optional | Message Type |
privacyPolicyLink | string | Optional | Privacy Policy Link |
termsOfServiceLink | string | Optional | Terms of Service |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text business Office Hours enable Business Hours, open Hours, outside Office Hours Welcome Msg, timezone
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
enableBusinessHours | boolean | Optional | Enable Business Hours |
openHours | array | Optional | Open hours schedule |
openHours[] | string | Each item | |
outsideOfficeHoursWelcomeMsg | string | Optional | Time Zone |
timezone | string | Optional | Time Zone |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text fb Page facebook Page Id, facebook Page Name
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
facebookPageId | string | Optional | Facebook Page ID |
facebookPageName | string | Optional | Facebook Page Name |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text instagram Page facebook Page Id, facebook Page Name, instagram Page Id, instagram Username
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
facebookPageId | string | Optional | Facebook Page ID |
facebookPageName | string | Optional | Facebook Page Name |
instagramPageId | string | Optional | Instagram Page ID |
instagramUsername | string | Optional | Instagram UserName |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color advance Settings a Two P Compliance, all In One Chat Types, all In One Initial Msg, branding Title, business Office Hours, contact Form Intro Message, contact Form Options, contact Form System Message, default Consent Check, enable Contact Form, fb Page, instagram Page, play Notification Sound, prefilled Message Text, redirect, voice Ai Agent, voice Ai Send Action Text redirect redirect Action, redirect Text, redirect Website
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
redirectAction | boolean | Optional | Redirect Action |
redirectText | string | Optional | Redirect Text |
redirectWebsite | string | Optional | Redirect Website |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
position | string | Optional | Position |
sizes | JSON | Optional | Typography Color Options |
sizes (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes sizes height, width |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes sizes height, width
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color dimensions position, sizes sizes height, width
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
height | number | Optional | Height |
width | number | Optional | Width |
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
colors | JSON | Optional | Custom Color Options |
colors (allOf 1) | Model | All variants apply | Expand Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name colors avatar Background Color, avatar Border Color, background Color, button Color, chat Bubble Color, header Color, received Message Color, sender Message Color |
name | string | Optional | Theme Name |
Referenced models: Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name colors avatar Background Color, avatar Border Color, background Color, button Color, chat Bubble Color, header Color, received Message Color, sender Message Color
Patch Chat Widget — request body — body settings acknowledgement Details, advance Settings, agency Name, agency Website, allow Avatar Image, auto Country Code, chat Icon, chat Type, country Code, dimensions, enable Revisit Message, heading, is Prompt Avatar Image Optimize, legal Msg, live Chat Ack Msg, live Chat Ended Msg, live Chat Feedback Msg, live Chat Feedback Note, live Chat Intro Msg, live Chat User Inactive Msg, live Chat User Inactive Time, live Chat Visitor Inactive Msg, live Chat Visitor Inactive Time, locale, location Country Code, prompt Avatar, prompt Avatar Alt Text, prompt Msg, prompt Type, representative Assigned Message, revisit Prompt Msg, send Action Text, show Agency Branding, show Consent Checkbox, show Live Chat Welcome Msg, show Prompt, sub Heading, success Msg, support Contact, thank You Msg, theme, use Email Field, wa Number, widget Id, widget Placement, widget Primary Color theme colors, name colors avatar Background Color, avatar Border Color, background Color, button Color, chat Bubble Color, header Color, received Message Color, sender Message Color
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
avatarBackgroundColor | string | Optional | Avatar Background Color |
avatarBorderColor | string | Optional | Avatar Border Color |
backgroundColor | string | Optional | Background Color |
buttonColor | string | Optional | Button Color |
chatBubbleColor | string | Optional | Chat Bubble Color |
headerColor | string | Optional | Header Color |
receivedMessageColor | string | Optional | Received Message Color |
senderMessageColor | string | Optional | Sender Message Color |
