For Developers
Start typing to search…

Create Message

post https://api.botpress.cloud/v1/chat/messages

Creates a new Message. When creating a new Message, the required tags must be provided. See the specific integration for more details.

Log in to see full request history

🚧

when using a delay, it should be at least 100ms

Body Params

Message data

payload
object
required

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

string
required
length between 28 and 36

ID of the User

string
required
length between 28 and 36

ID of the Conversation

string
required
length ≤ 200

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

tags
object
required

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

schedule
object

Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.

Headers
string
required

Integration ID

string
required

Bot ID

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
PAT
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?