Success response
Queue message endpoints return200 OK when the request is accepted.
{
"queued": true,
"messageId": "01a172ee-9200-7000-8000-000000000001",
"status": "Pending"
}
This response confirms the message was queued successfully. It does not
confirm final delivery. Save
messageId and use the
message status endpoint to track delivery and read receipts.Error format
All API errors follow the Problem Details specification.Common errors
| Status | Error | Description |
|---|---|---|
401 | Unauthorized | Missing or invalid X-API-KEY app token. |
400 | RecipientMissing | The raw payload did not include recipient. |
400 | RecipientInvalid | recipient is not an international phone number, BSUID, or group ID (e.g. a local 07… number). |
400 | TemplateKeyRequired | The raw payload did not include template.name. |
400 | WhatsAppBusinessIdRequired | The raw request did not include whatsappBusinessId. |
400 | PhoneNumberIdRequired | The raw request did not include phoneNumberId. |
400 | WhatsAppBusinessIdDoesNotBelongToApp | The WABA does not belong to the app token. |
400 | AppNotLinkedToWhatsAppBusiness | The app is not linked to a WhatsApp business account. |
400 | RecipientRateLimitExceeded | The app’s per-recipient rate limit was exceeded. |
400 | InsufficientBalance | The account balance is too low to cover the message cost. |