updateMessage

Updates a message tags and payload. The message type cannot be changed. Calling this operation from an integration, to update an incoming message, will not invoke the bot. The other way around it also true; Calling this operation from the bot, to update an outgoing message, will not invoke the integration.

PUT /v1/chat/messages/{id}

Try it

cURL

cURL

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

200

{
  "message": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "direction": "incoming",
    "userId": "<string>",
    "conversationId": "<string>",
    "tags": {},
    "origin": "synthetic"
  }
}

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

Message id

Body

application/json

Message data

tags · object · required

Set of Tags that you can attach to a Conversation. The set of Tags available on a Conversation is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.

Show child attributes

tags. {key} · string

payload · object

Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location

Response

200

application/json

Message information

message · object · required

The Message object represents a message in a Conversation for a specific User.

Show child attributes

message. id · string · required

Id of the Message

Required string length: 28 - 36

message. createdAt · string<date-time> · required

Creation date of the Message in ISO 8601 format

message. updatedAt · string<date-time> · required

Update date of the Message in ISO 8601 format

message. type · string · required

Type of the Message represents the resource type that the message is related to

Maximum string length: 200

message. payload · object · required

Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location

message. direction · enum<string> · required

Direction of the message (incoming or outgoing).

Available options: incoming, outgoing

message. userId · string · required

ID of the User

Required string length: 28 - 36

message. conversationId · string · required

ID of the Conversation

Required string length: 28 - 36

message. tags · object · required

Set of Tags that you can attach to a Conversation. The set of Tags available on a Conversation is restricted by the list of Tags defined previously by the Bot. Individual keys can be unset by posting an empty value to them.

Show child attributes

message.tags. {key} · string

message. origin · enum<string>

Origin of the message (synthetic).

Available options: synthetic