Campaign API | ActiWAPI

Create and manage bulk messaging campaigns.

GET/api/campaigns

List campaigns

Returns paginated campaigns for your tenant.

URL: https://api.actiwapi.com/api/campaigns

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Query parameters

page — Page number
status — Filter by status: draft, running, paused, completed

Code examples

curl -X GET "https://api.actiwapi.com/api/campaigns" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": [{ "id": "uuid", "name": "March Promo", "status": "running", "sentCount": 120 }],
  "pagination": { "page": 1, "total": 5 }
}

Try in Swagger UI

POST/api/campaigns

Create campaign

Create a draft campaign with message content and target contacts or groups.

URL: https://api.actiwapi.com/api/campaigns

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Request example

{
  "name": "March Promo",
  "sessionId": "uuid",
  "message": "Hello {{name}}, check out our offer!",
  "contactIds": ["uuid-1", "uuid-2"],
  "contactGroupIds": []
}

Code examples

curl -X POST "https://api.actiwapi.com/api/campaigns" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{  "name": "March Promo",  "sessionId": "uuid",  "message": "Hello {{name}}, check out our offer!",  "contactIds": ["uuid-1", "uuid-2"],  "contactGroupIds": []}'

Response example201

{ "success": true, "data": { "id": "uuid", "status": "draft" } }

Try in Swagger UI

POST/api/campaigns/{id}/start

Start campaign

Start sending messages immediately.

URL: https://api.actiwapi.com/api/campaigns/{id}/start

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Campaign UUID

Code examples

curl -X POST "https://api.actiwapi.com/api/campaigns/{id}/start" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{ "success": true, "data": { "id": "uuid", "status": "running" } }

Try in Swagger UI

POST/api/campaigns/{id}/pause

Pause campaign

Pause a running campaign.

URL: https://api.actiwapi.com/api/campaigns/{id}/pause

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Campaign UUID

Code examples

curl -X POST "https://api.actiwapi.com/api/campaigns/{id}/pause" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{ "success": true, "data": { "status": "paused" } }

Try in Swagger UI

POST/api/campaigns/{id}/schedule

Schedule campaign

Schedule a campaign for future delivery.

URL: https://api.actiwapi.com/api/campaigns/{id}/schedule

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Campaign UUID

Request example

{ "scheduledAt": "2026-06-01T10:00:00.000Z" }

Code examples

curl -X POST "https://api.actiwapi.com/api/campaigns/{id}/schedule" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"
  -d '{ "scheduledAt": "2026-06-01T10:00:00.000Z" }'

Response example200

{ "success": true, "data": { "status": "scheduled" } }

Try in Swagger UI

GET/api/campaigns/{id}/analytics

Campaign analytics

Delivery statistics for a campaign.

URL: https://api.actiwapi.com/api/campaigns/{id}/analytics

Auth: JWT Bearer

Headers

Header	Value	Required
Authorization	Bearer {accessToken}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Campaign UUID

Code examples

curl -X GET "https://api.actiwapi.com/api/campaigns/{id}/analytics" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {accessToken}"

Response example200

{
  "success": true,
  "data": {
    "totalRecipients": 500,
    "sentCount": 320,
    "failedCount": 2,
    "deliveredCount": 300
  }
}

Try in Swagger UI

Error codes

Failed requests return a JSON envelope with success: false and a human-readable message.

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "phone": "Valid phone number is required"
  }
}

HTTP	Code	Description
400	VALIDATION_ERROR	Request body or query failed validation.
401	UNAUTHORIZED	Missing or invalid JWT / API key.
403	FORBIDDEN	Authenticated but lacking permission or entitlement.
403	SUBSCRIPTION_INACTIVE	Trial expired or subscription not active.
403	LIMIT_EXCEEDED	Plan limit reached (sessions, messages, API requests, etc.).
404	NOT_FOUND	Resource does not exist or is not in your tenant.
409	CONFLICT	Duplicate resource or invalid state transition.
429	RATE_LIMITED	Too many requests; retry after backoff.
500	INTERNAL_ERROR	Unexpected server error.
502	WHATSAPP_UNAVAILABLE	WhatsApp session disconnected or provider error.

← Back to Getting Started