Skip to navigation

Update embedded assistant settings

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
font_familystringOptional

Custom font family for the chat, in CSS font-family syntax. Invalid values are ignored and the default font is used.

avatar_buttonobjectOptional
Settings for the assistant avatar button.
close_buttonobjectOptional
Settings for the chat close button.
speech_bubbleobjectOptional
Controls how the speech bubble above the avatar is displayed.
full_screen_heightstringOptional

Height of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.

full_screen_widthstringOptional

Width of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.

display_urlsobjectOptional
Wildcard URL patterns that decide on which pages the assistant is displayed.
proactive_popup_urlsobjectOptional
Wildcard URL patterns that decide on which pages the chat opens automatically.

Response

The updated embedded assistant settings, at its new version
font_familystringOptional

Custom font family for the chat, in CSS font-family syntax. Invalid values are ignored and the default font is used.

avatar_buttonobjectOptional
Settings for the assistant avatar button.
close_buttonobjectOptional
Settings for the chat close button.
speech_bubbleobjectOptional
Controls how the speech bubble above the avatar is displayed.
full_screen_heightstringOptional

Height of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.

full_screen_widthstringOptional

Width of the full screen chat window, in CSS syntax. Invalid values are ignored and the default of 100% is used.

display_urlsobjectOptional
Wildcard URL patterns that decide on which pages the assistant is displayed.
proactive_popup_urlsobjectOptional
Wildcard URL patterns that decide on which pages the chat opens automatically.
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.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error