api docs
Send Bulk Campaign
Send text messages to multiple recipients in sequence with configurable delays.
Send Bulk Campaign
Send a text message to multiple recipients in sequence with a configurable delay between messages.
Scope: `send_bulk` | Method: `POST`
POST /api/v1/messages/send-bulk
Request Body
ParameterTypeRequiredDescription
numbersarray of stringsYesList of recipient phone numbers with country codesmessagestringYesThe campaign message bodydelaynumberNoSeconds to wait between consecutive sends (default: 5)session_idstringNoOverrides the default assigned WhatsApp sessionExample Request
curl -X POST "https://whatapi.pk/api/v1/messages/send-bulk" \
-H "Authorization: Bearer whatapi_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"numbers": ["923001234567", "923009876543"],
"message": "Special offers inside!",
"delay": 3
}'Response
{
"success": true,
"total_requested": 2,
"total_processed": 2,
"successful": 2,
"failed": 0,
"details": [
{
"number": "923001234567",
"success": true,
"messageId": "abc123"
},
{
"number": "923009876543",
"success": true,
"messageId": "def456"
}
],
"timestamp": "2026-07-02T12:00:00.000Z"
}Behavior
- Messages are sent **sequentially**, one at a time
- A delay of N seconds is applied between each message
- Each message's success/failure is tracked individually in the `details` array
- The system respects your **monthly message limit** — the batch is clipped to remaining allowance
- Only successfully sent messages increment the `messagesSent` counter
- Failed messages include an `error` field in their detail object
