Get display settings
Returns your organization’s display settings. There is one per organization, so there is no id.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Response
Your organization's display settings
bot_friendly_name
Name the assistant uses to refer to itself. Other fields can reference it with {{ bot_friendly_name }}.
handoff_category_names
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_desc
Descriptions shown beneath each handoff category, keyed by category key. An update replaces the whole map.
handoff_item_names
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_descs
Descriptions shown beneath each handoff item, keyed by item key. An update replaces the whole map.
handoff_item_action_texts
Button label for each handoff item, keyed by item key, for example Visit Facilities Portal. An update replaces the whole map.
handoff_item_disclaimers
Additional information or disclaimer shown under a handoff item, keyed by item key. An update replaces the whole map.
welcome_message_to_portal_mapping
Web chat welcome message for each portal, keyed by portal system name. Overrides default_welcome_message for that portal.
default_welcome_message
Welcome message shown when users first open web chat, for portals without a specific message.
webchat_chatbox_placeholder
Placeholder text shown in the web chat input box.
updated_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
Document version. On update, send back the num from your last read.
Errors
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error