Skip to navigation

Update surface

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. The id goes in the URL; if you also send id in the body it must match.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The id of the surface, as returned when it was created or listed.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
assistant_idstringOptional
Bot ID of the account the assistant sends messages from, e.g. the Slack bot ID starting with B or the Google Chat bot email. For web chat it is generated from name and can be left empty on create.
assistant_namestringOptionalformat: "^.+$"

Customer-facing display name of the bot, usually the same across all of an organization’s bots.

file_attachment_enabledbooleanOptional
If true, users can send file attachments to the bot.
ms_teams_configobjectOptional
Microsoft Teams settings. Set this when channel is msteams.
slack_configobjectOptional
Slack settings. Set this when channel is slack.
movewebchat_configobjectOptional
Moveworks web chat settings. Set this when channel is movewebchat.
gchat_configobjectOptional
Google Chat settings. Set this when channel is gchat.
webex_configobjectOptional
Webex settings. Set this when channel is webex.
zoom_configobjectOptional
Zoom settings. Set this when channel is zoom.
glip_configobjectOptional

Glip (RingCentral) settings. Set this when channel is glip.

sms_configobjectOptional
SMS settings. Set this when channel is sms.
conversations_rest_api_configobjectOptional

Conversations REST API settings. Set this when channel is conversationsrestapi; it has no fields.

Response

The updated surface, at its new version
idstringOptionalRead-only
Unique ID of this configuration, assigned by the server.
assistant_idstringOptional
Bot ID of the account the assistant sends messages from, e.g. the Slack bot ID starting with B or the Google Chat bot email. For web chat it is generated from name and can be left empty on create.
namestringOptionalformat: "^[\w-]+$"

Unique Moveworks identifier for the bot, in the form orgname-channel (e.g. acme-slack). Letters, digits, underscores and hyphens only. Cannot be changed after creation.

assistant_namestringOptionalformat: "^.+$"

Customer-facing display name of the bot, usually the same across all of an organization’s bots.

channelenumOptional

Chat platform this bot runs on. Allowed values: msteams, movewebchat, slack, gchat, webex, zoom, glip, sms, conversationsrestapi. Cannot be changed after creation.

connector_idstringOptional

Connector used for this chat integration. Required except for movewebchat, gchat, zoom and webex, where one is created automatically if left empty. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

file_attachment_enabledbooleanOptional
If true, users can send file attachments to the bot.
ms_teams_configobjectOptional
Microsoft Teams settings. Set this when channel is msteams.
slack_configobjectOptional
Slack settings. Set this when channel is slack.
movewebchat_configobjectOptional
Moveworks web chat settings. Set this when channel is movewebchat.
gchat_configobjectOptional
Google Chat settings. Set this when channel is gchat.
webex_configobjectOptional
Webex settings. Set this when channel is webex.
zoom_configobjectOptional
Zoom settings. Set this when channel is zoom.
glip_configobjectOptional

Glip (RingCentral) settings. Set this when channel is glip.

sms_configobjectOptional
SMS settings. Set this when channel is sms.
conversations_rest_api_configobjectOptional

Conversations REST API settings. Set this when channel is conversationsrestapi; it has no fields.

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
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error