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>' \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --data '
{
  "currentTaskId": "<string>",
  "tags": {},
  "properties": {}
}
'

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>",
    "properties": {}
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bp-authenticated-principal · string · required

Authenticated principal. Injected by the authentication middleware.

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-real-ip · string

Caller's IP address. Injected by the edge proxy.

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. Set to null or empty string to remove.

Show child attributes

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.

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