Campaigns API

Create and manage broadcast campaigns — bulk outbound messages sent via approved templates to a segmented audience.

Prerequisites: Campaigns require an approved template and contacts with the target tags. See Templates API and Contacts API.

Campaign Lifecycle

draft→scheduled→running→paused→completed→cancelled

List Campaigns

GEThttps://api.vobiz.ai/v1/messaging/campaigns

Returns all campaigns with status, delivery counts, and scheduling details.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

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}"

Response — 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

POSThttps://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.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

Field	Required	Description
name	Required	Campaign display name
channel_id	Required	Channel to send from
template_name	Required	Approved template name
template_language	Required	Template language (e.g. en_US)
audience_type	Required	"tags" — targets contacts matching target_tags
target_tags	Required	Array of contact tags to target
scheduled_at	Optional	ISO 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

GEThttps://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}

Returns full details and delivery statistics for a specific campaign.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

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 using action endpoints. All three use POST with no request body.

POSThttps://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/pause

Pause a running campaign. Sending stops immediately. Resume it later.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

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}"

POSThttps://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/resume

Resume a paused campaign. Sending continues from where it stopped.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X POST \
  "https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/resume" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

POSThttps://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/cancel

Permanently cancel a campaign. Cannot be undone — pending messages will not be sent.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

cURL

curl -X POST \
  "https://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/cancel" \
  -H "X-Auth-ID: {auth_id}" \
  -H "X-Auth-Token: {auth_token}"

List Campaign Recipients

GEThttps://api.vobiz.ai/v1/messaging/campaigns/{campaign_id}/recipients

Returns per-contact delivery status for a campaign. Use to audit delivery rates or identify failed recipients.

Authentication Required:

• X-Auth-ID: Your Account Auth ID
• X-Auth-Token: Your Account Auth Token
• Accept: application/json

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}"

Response — 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"}]
}

Templates API

Canned Responses API

Last updated: April 2026Edit this page