Skip to main content
POST
/
message
/
platform
curl --request POST \
  --url https://api.example.com/message/platform \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "conv_123",
  "sender": "location",
  "type": "text",
  "content": "Your order has been confirmed!"
}
'
{
  "code": "MESSAGE_VALIDATION_ERROR",
  "message": "Invalid message data",
  "details": {
    "missingFields": [
      "id",
      "conversationId",
      "content"
    ]
  }
}

Body

application/json

Platform message data

​
conversationId
string
required

ID of the conversation this message belongs to

Example:

"conv_abcd1234"

​
sender
enum<string>
required

Who is sending the message

Available options:
customer,
location
Example:

"customer"

​
type
enum<string>
required

Type of message - text for simple text messages

Available options:
text
Example:

"text"

​
content
string
required

The text content of the message

Example:

"Hello, I would like to order a pizza"

Response

Platform message sent successfully