Skip to main content
POST
/
v1
/
messaging
/
campaigns
Campaigns API
curl --request POST \
  --url https://api.example.com/v1/messaging/campaigns

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

Prerequisites: Campaigns require an approved template and contacts with the target tags. See Templates API and Contacts API.
Authentication: X-Auth-ID, X-Auth-Token, Accept: application/json

​
Campaign lifecycle

draft → scheduled → running → paused → completed / cancelled

​
List campaigns

GET https://api.vobiz.ai/v1/messaging/campaigns
Returns all campaigns with status, delivery counts, and scheduling details.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/campaigns?page=1&limit=20" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
200 OK
{
  "data": [{"id":"camp_abc123","name":"Welcome Campaign","status":"completed","sent_count":142,"delivered_count":138,"read_count":95}],
  "meta": {"total":1,"page":1}
}

​
Create campaign

POST https://api.vobiz.ai/v1/messaging/campaigns
Create a new campaign. Set audience_type to tags and provide target_tags to target contacts. Set scheduled_at for a future send, or omit to send immediately.
FieldRequiredDescription
nameYesCampaign display name
channel_idYesChannel to send from
template_nameYesApproved template name
template_languageYesTemplate language (e.g. en_US)
audience_typeYestags - targets contacts matching target_tags
target_tagsYesArray of contact tags to target
scheduled_atNoISO 8601 datetime for scheduled send
cURL
curl -X POST \
  "https://api.vobiz.ai/v1/messaging/campaigns" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}" \
  -H "Content-Type: application/json" \
  -d '{"name":"Welcome Campaign","channel_id":"{channel_id}","template_name":"hello_world","template_language":"en_US","audience_type":"tags","target_tags":["vip"],"scheduled_at":"2026-03-25T10:00:00Z"}'

​
Get campaign

GET https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}
Returns full details and delivery statistics for a specific campaign.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
Campaign actions

Control campaign execution. All three use POST with no request body.
EndpointDescription
POST /campaigns/{id}/pausePause a running campaign. Sending stops immediately.
POST /campaigns/{id}/resumeResume a paused campaign.
POST /campaigns/{id}/cancelPermanently cancel. Cannot be undone.
cURL - pause
curl -X POST "https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/pause" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

​
List campaign recipients

GET https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/recipients
Returns per-contact delivery status. Use to audit delivery rates or identify failed recipients.
cURL
curl -X GET \
  "https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/recipients?page=1&limit=50" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"
200 OK
{
  "data": [{"contact_id":"cnt_xyz789","phone_number":"+919876543210","status":"read","sent_at":"2026-03-25T10:00:05Z","delivered_at":"2026-03-25T10:00:07Z","read_at":"2026-03-25T10:15:00Z"}]
}