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}

cURL

cURL

curl --request PUT \
  --url https://api.botpress.cloud/v1/chat/conversations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <x-bot-id>' \
  --data '
{
  "currentTaskId": "<string>",
  "tags": {}
}
'

200

{
  "conversation": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "channel": "<string>",
    "integration": "<string>",
    "tags": {},
    "messageCount": 123,
    "currentTaskId": "<string>",
    "currentWorkflowId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Path Parameters

id · string · required

Conversation id

Body

application/json

Conversation data

currentTaskId · string · deprecated

Unused. This parameter will be ignored if provided and should not be used when updating a conversation.

tags · object

Tags for the Conversation

Show child attributes

Response

200

application/json

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

conversation · object · required

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.

Show child attributes