Send Text Message

Send WhatsApp Message

post

Sends a WhatsApp message (text or template) through the WhatsApp channel within the specified workspace.

Path parameters

workspacestringRequired

Workspace UUID

Example: 3df284cf-eb1a-4314-8784-8c5d9b28040c

channelstringRequired

WhatsApp Channel UUID

Example: 9ded1284-72b1-40b6-8c96-10c51d4f7926

Body

application/json

or

Responses

200

WhatsApp message sent successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Message Sent Successfully

400

Bad Request — invalid type or configuration

application/json

401

Unauthorized — Access token invalid

application/json

403

Forbidden — Access Denied

422

Validation error

application/json

post

/workspaces/{workspace}/channels/{channel}/messages

HTTPcURLJavaScriptPython

POST /v1.0/workspaces/{workspace}/channels/{channel}/messages HTTP/1.1
Host: api.dreams.sa
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "to": {
    "type": "phone-number",
    "value": "[phone]"
  },
  "type": "text",
  "text": {
    "body": "Hello 👋 from Dreams WhatsApp API!",
    "preview_url": true
  }
}

Send WhatsApp Text MessageSend WhatsApp Template Message

{
  "success": true,
  "message": "Message Sent Successfully",
  "data": {
    "id": "wamid.HBgMNTU1NTcwMjkyNTEVAgASGBQzNjk3Njk3Q",
    "conversation_id": "conv_f87f94e1-6017-4d2b-aa35-0e719840c88e",
    "type": "text",
    "status": "initiated",
    "direction": "SENT",
    "content": {},
    "created_at": "2025-11-11T14:12:59Z"
  }
}