Skip to main content
POST
/
whatsapp
/
campaigns
/
{_id}
/
recipients
Attach recipients to a campaign
curl --request POST \
  --url https://api.otpiq.com/api/whatsapp/campaigns/{_id}/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipients": [
    {
      "phoneNumber": "9647712345678",
      "templateParameters": {
        "body": {},
        "header": {},
        "buttons": {}
      }
    }
  ]
}
'
{
  "success": true,
  "data": {
    "_id": "<string>",
    "campaignId": "<string>",
    "name": "<string>",
    "template": "<string>",
    "phoneNumber": "<string>",
    "scheduledFor": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "totalRecipients": 123,
    "sentCount": 123,
    "deliveredCount": 123,
    "failedCount": 123,
    "estimatedTotalCost": 123,
    "reservedAmount": 123,
    "reconciledAmount": 123,
    "isSampleCampaign": true,
    "sampleOfCampaign": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
This endpoint appends new recipients to the existing list.
  • Phone numbers already on the campaign are skipped.
  • Duplicates within the same request are deduplicated.
  • A campaign can have a maximum of 1000 recipients total. If appending would exceed this limit, a 400 error is returned.
  • If every number in your request already exists on the campaign, a 400 error is returned.

Authorizations

​
Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Path Parameters

​
_id
string
required

Campaign MongoDB id returned on create

Pattern: ^[a-fA-F0-9]{24}$

Body

application/json
​
recipients
object[]
required
Required array length: 1 - 1000 elements

Response

Recipients attached

​
success
enum<boolean>
required
Available options:
true
​
data
object
required