Docs

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

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

Header parameters

x-bp-authenticated-principalstring
Authenticated principal. Injected by the authentication middleware.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias

Path parameters

idstring
Conversation id

Request body

Conversation data

currentTaskId?stringdeprecated
Unused. This parameter will be ignored if provided and should not be used when updating a conversation.
tags?object
Tags for the Conversation. Set to null or empty string to remove.
properties?object
**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.

Response

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

conversationobject
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.