Sending messages in WhatsApp
Last updated: 16 October 2026
Use the /api/v2/out-messages/whatsapp method to send messages to the WhatsApp channel.
tip
We recommend using the /api/v2/out-messages/whatsapp method to support BSUID.
info
The /api/v1/out-messages/whatsapp method is deprecated but remains available for use.
Calling the method
To send a message to the WhatsApp channel using the /api/v2/out-messages/whatsapp method, send a POST request to https://app.edna.io/api/v2/out-messages/whatsapp.
Request examples
Text message
{
"from": "test_WA",
"to": {
"value": "DE.1234567890123456789",
"type": "WHATSAPP_BSUID"
},
"content": {
"type": "TEXT",
"text": "Hi! We hope you have a great day!"
}
}
Request parameters
| Parameter | Data type | Requirement | Description |
|---|---|---|---|
outMessageId | string | Optional | Internal identifier of the outgoing message. The customer’s external system or edna Pulse generates it when sending the message. The maximum string length is 256 characters. |
from | string | Required | Channel name.
To get the channel name, use the API method to get the list of channels — the subject parameter.
Receiving list of channels |
to | object | Required | Object with recipient identifier information. |
to.value | string | Required | Recipient identifier.
To get the recipient identifier, use the API method to request recipient data — the addresses.address parameter.
Requesting client data |
to.type | string | Required | Recipient identifier type.
Possible values: - PHONE — phone number;
- WHATSAPP_BSUID — Business-Scoped User ID (BSUID);
- WHATSAPP_PARENT_BSUID — Parent Business-Scoped User ID (Parent BSUID). |
content | object | Required | Object with message content information. |
content.type | string | Required | Message content type.
Possible values: - TEXT — text;
- IMAGE — image;
- DOCUMENT — document. |
content.text | string | Required | Message text. |
Response format
{
"outMessageId": "string"
}
Response example
{
"outMessageId": "01987f4a-070e-730e-bf59-cedc1e63350"
}
Response parameters
| Parameter | Data type | Description |
|---|---|---|
outMessageId | string | Internal identifier of the outgoing message. The customer’s external system or edna Pulse generated it when sending the message. |