updateConversation

Update a Conversation object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PUT/v1/chat/conversations/{id}

Authorization

AuthorizationBearerrequired
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias

Path parameters

idstringrequired
Conversation id

Request body

Conversation data

currentTaskIdstringdeprecated
Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
tagsobject
Tags for the Conversation

Response

Returns an updated Conversation object if a valid identifier was provided. Returns an error otherwise

conversationobjectrequired
The Conversation object represents an exchange of messages between one or more users. A Conversation is always linked to an integration's channels. For example, a Slack channel represents a conversation.