MCP is live.Set upAsk the community
OmniDimension
WhatsApp

Add campaign contacts

Add one contact, or up to 500 at once. On a draft they are stored for launch. On a running campaign they are sent now. A contact already in the campaign is skipped, so a retry is safe. Each contact needs a phone_number; every other key is kept and can fill a template parameter through variable_mapping.

Set up WhatsApp first. Connect a WhatsApp number in the dashboard or with Connect numbers. Included on every paid plan. See plans.

POST/whatsapp/campaigns//contacts
Path parameters
campaign_idrequired
Body
curl -X POST 'https://omnidim.io/api/v1/whatsapp/campaigns/{campaign_id}/contacts' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example response
synthetic
{
  "imported": 0,
  "skipped_invalid": 0,
  "skipped_duplicate": 0,
  "total_submitted": 0,
  "contacts": [
    {
      "index": 0,
      "contact_id": 0,
      "duplicate": false
    }
  ],
  "errors": [
    {
      "index": 0,
      "error": "string"
    }
  ]
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

campaign_id*integer

Id of a WhatsApp campaign, from listWhatsappCampaigns.

Request Body

application/json

One contact object, or an array of 1 to 500.

body?

One contact object, or an array of 1 to 500.

Response body

application/json

Response Body

What happened to each contact.

application/json

What happened to each contact you sent.

imported?integer
skipped_invalid?integer
skipped_duplicate?integer
total_submitted?integer
contacts?

One entry per contact that was accepted or already existed.

errors?

One entry per contact that was skipped.