Engagive API documentation

Channels · WhatsApp · Campaigns

Lifecycle actions

Base URL & auth

  • Prefix: /api/business/public on https://api.engagive.io (full base: https://api.engagive.io/api/business/public).
  • Header: Authorization: Bearer <token> — create the token under Profile → API access token in the business app.
  • See also: Authentication, Errors & responses.

Move a campaign through send-test → launch/schedule → pause/resume/cancel. Launch is allowed from draft or scheduled.

POST

Send test

Required permission: WhatsApp Campaigns — Edit

Send one test using contact_id or phone_number (+ optional country_code).

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/send-test
Example request body (JSON)
{
  "contact_id": 42
}
Example success response (JSON)
{
  "success": true,
  "message": "Test message sent",
  "data": {}
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/send-test
POST

Launch campaign

Required permission: WhatsApp Campaigns — Edit

Launch from draft or scheduled. Optional body `{ "test_mode": true }`.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/launch
Example success response (JSON)
{
  "success": true,
  "message": "Campaign launched",
  "data": {
    "status": "preparing"
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/launch
POST

Schedule campaign

Required permission: WhatsApp Campaigns — Edit

scheduled_at required (ISO-8601). Optional test_mode.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/schedule
Example request body (JSON)
{
  "scheduled_at": "2026-08-10T09:00:00.000Z",
  "test_mode": false
}
Example success response (JSON)
{
  "success": true,
  "message": "Campaign scheduled",
  "data": {
    "status": "scheduled"
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/schedule
POST

Pause campaign

Required permission: WhatsApp Campaigns — Edit

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/pause
Example success response (JSON)
{
  "success": true,
  "message": "Campaign paused",
  "data": {
    "status": "paused"
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/pause
POST

Resume campaign

Required permission: WhatsApp Campaigns — Edit

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/resume
Example success response (JSON)
{
  "success": true,
  "message": "Campaign resumed",
  "data": {
    "status": "running"
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/resume
POST

Cancel campaign

Required permission: WhatsApp Campaigns — Edit

Path
/api/business/public/channels/whatsapp/accounts/:accountId/campaigns/:campaignId/cancel
Example success response (JSON)
{
  "success": true,
  "message": "Campaign cancelled",
  "data": {
    "status": "cancelled"
  }
}

Try it

Runs in your browser — token is not stored

If the request fails with a network / CORS error, your API may not allow browser calls from this site. Use curl, Postman, or your server instead. See Postman.

Full request URL
POST https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/campaigns/100/cancel