POST
/
v1
/
chat
/
messages
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "payload": {},
  "userId": "<string>",
  "conversationId": "<string>",
  "type": "<string>",
  "tags": {},
  "schedule": {
    "dateTime": "<string>",
    "delay": 123
  }
}'
{
  "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": {}
  }
}

Authorizations

​
Authorization
string
header
required

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

​
x-bot-id
string
header
required

Your bot ID.

Body

application/json

Message data

The body is of type object.

Response

201
application/json

Returns a Message object if creation succeeds.

The response is of type object.