Request
This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
bot_friendly_namestringOptional
Name the assistant uses to refer to itself. Other fields can reference it with {{ bot_friendly_name }}.
handoff_category_namesmap from strings to stringsOptional
Display titles for handoff categories, keyed by category key. Each key must match a configured handoff category. An update replaces the whole map.
handoff_category_descmap from strings to stringsOptional
Descriptions shown beneath each handoff category, keyed by category key. An update replaces the whole map.
handoff_item_namesmap from strings to stringsOptional
Display titles for handoff items, keyed by item key. Each key must match a configured handoff item. An update replaces the whole map.
handoff_item_descsmap from strings to stringsOptional
Descriptions shown beneath each handoff item, keyed by item key. An update replaces the whole map.
handoff_item_action_textsmap from strings to stringsOptional
Button label for each handoff item, keyed by item key, for example Visit Facilities Portal. An update replaces the whole map.
handoff_item_disclaimersmap from strings to stringsOptional
Additional information or disclaimer shown under a handoff item, keyed by item key. An update replaces the whole map.
welcome_message_to_portal_mappingmap from strings to stringsOptional
Web chat welcome message for each portal, keyed by portal system name. Overrides default_welcome_message for that portal.
default_welcome_messagestringOptional
Welcome message shown when users first open web chat, for portals without a specific message.
webchat_chatbox_placeholderstringOptional
Placeholder text shown in the web chat input box.
Response
The updated display settings, at its new version
bot_friendly_namestringOptional
Name the assistant uses to refer to itself. Other fields can reference it with {{ bot_friendly_name }}.
handoff_category_namesmap from strings to stringsOptional
Display titles for handoff categories, keyed by category key. Each key must match a configured handoff category. An update replaces the whole map.
handoff_category_descmap from strings to stringsOptional
Descriptions shown beneath each handoff category, keyed by category key. An update replaces the whole map.
handoff_item_namesmap from strings to stringsOptional
Display titles for handoff items, keyed by item key. Each key must match a configured handoff item. An update replaces the whole map.
handoff_item_descsmap from strings to stringsOptional
Descriptions shown beneath each handoff item, keyed by item key. An update replaces the whole map.
handoff_item_action_textsmap from strings to stringsOptional
Button label for each handoff item, keyed by item key, for example Visit Facilities Portal. An update replaces the whole map.
handoff_item_disclaimersmap from strings to stringsOptional
Additional information or disclaimer shown under a handoff item, keyed by item key. An update replaces the whole map.
welcome_message_to_portal_mappingmap from strings to stringsOptional
Web chat welcome message for each portal, keyed by portal system name. Overrides default_welcome_message for that portal.
default_welcome_messagestringOptional
Welcome message shown when users first open web chat, for portals without a specific message.
webchat_chatbox_placeholderstringOptional
Placeholder text shown in the web chat input box.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.