Patch Chat Widget

PATCH 
/chat-widget/data/:locationId/:id

Applies a partial update to an existing chat widget

Request

Version stringrequired

API Version

Available optionsv3

id stringrequired

The chat widget ID

locationId stringrequired

The location ID

application/json

application/json

Body

Bodyrequired

versionnumber

Version

chatTypestring
Chat Type. The public API supports only liveChat and emailChat; any other value is rejected with a 422.
Available optionsliveChatemailChat
namestring

Name

defaultboolean

Default

settingsobject

Settings

Example (auto)

{
  "version": 2,
  "chatType": "emailChat",
  "name": "Chat Widget 1",
  "default": false,
  "settings": {
    "promptType": "avatar",
    "locale": "en-us",
    "heading": "Welcome to Acme",
    "widgetPrimaryColor": "#4285F4",
    "theme": {
      "name": "blue"
    }
  }
}

application/json

Success

application/json

Schema

Schema

_idstringrequired

Chat widget ID

versionnumberrequired

Schema version of the widget

chatTypestringrequired
Chat Type. Reads are not restricted to the public-API write allow-list, so any stored chat type can be returned here.
Available optionsliveChatwaChatemailChatallInOneChatvoiceAiChatfacebookChatinstagramChat
namestringrequired

Widget name

locationIdstringrequired

The location ID that owns this widget

deletedbooleanrequired

Whether the widget is soft-deleted

defaultbooleanrequired

Whether this is the default widget for the location

settingsobject

Widget settings

creationSourcestring
How the widget was created
Available optionschat-widgeta2pCompliancepublic-apisnapshot
updatedBystring

ID of the user who last updated the widget

originIdstring

ID of the widget this one was cloned or imported from

createdAtstringrequired

Creation timestamp (ISO 8601)

updatedAtstringrequired

Last update timestamp (ISO 8601)

Example (auto)

{
  "_id": "ve9EPM428h8vShlRWsss",
  "version": 2,
  "chatType": "emailChat",
  "name": "Chat Widget 1",
  "locationId": "ve9EPM428h8vShlRWsss",
  "deleted": false,
  "default": false,
  "settings": {
    "acknowledgementDetails": {},
    "agencyName": "Example Agency",
    "agencyWebsite": "https://example.com",
    "allowAvatarImage": true,
    "autoCountryCode": true,
    "countryCode": "US",
    "chatType": "emailChat",
    "promptType": "avatar",
    "chatIcon": "messageChatCircle",
    "enableRevisitMessage": true,
    "heading": "Welcome to Our Website",
    "legalMsg": "By using this website, you agree to our terms and conditions.",
    "liveChatAckMsg": "Thank you for reaching out. How may I assist you today?",
    "liveChatEndedMsg": "Thank you for chatting with us. Have a great day!",
    "liveChatFeedbackMsg": "We would appreciate your feedback. Please rate your experience.",
    "liveChatFeedbackNote": "Your feedback helps us improve our services.",
    "liveChatIntroMsg": "Hello! Welcome to our live chat support. How can I assist you today?",
    "liveChatUserInactiveMsg": "Are you still there? Please let us know if you need assistance.",
    "liveChatUserInactiveTime": "5 minutes",
    "liveChatVisitorInactiveMsg": "Looks like you stepped away. Feel free to return whenever you need help.",
    "liveChatVisitorInactiveTime": "10 minutes",
    "locale": "en-us",
    "promptAvatar": "avatar.jpg",
    "promptAvatarAltText": "company logo",
    "isPromptAvatarImageOptimize": false,
    "promptMsg": "Need assistance? Feel free to ask us anything!",
    "revisitPromptMsg": "Welcome back! How can we help you today?",
    "sendActionText": "Send",
    "showAgencyBranding": true,
    "showConsentCheckbox": true,
    "showLiveChatWelcomeMsg": true,
    "showPrompt": true,
    "subHeading": "We are here to help you!",
    "successMsg": "Your message has been sent successfully.",
    "supportContact": "[email protected]",
    "thankYouMsg": "Thank you for visiting our website!",
    "theme": {},
    "waNumber": "+1234567890",
    "widgetPrimaryColor": "#4285F4",
    "representativeAssignedMessage": "#4285F4",
    "dimensions": {},
    "advanceSettings": {},
    "locationCountryCode": "US",
    "widgetPlacement": "embedded",
    "loadStrategy": "interaction"
  },
  "creationSource": "chat-widget",
  "updatedBy": "oHJiAh0wDG3BzmzACVD6",
  "originId": "ve9EPM428h8vShlRWsss",
  "createdAt": "2026-08-17T09:24:11.123Z",
  "updatedAt": "2026-08-17T09:24:11.123Z"
}