Engagive API documentation

Channels · WhatsApp · Flows

Flow APIs

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.

These are Meta WhatsApp Flows (interactive form JSON on WhatsApp), not Engagive Automations.

CRUD for Flow definitions scoped to an account. Actor fields default from your API access token.

GET

List Flows

Required permission: WhatsApp Flows — View

Meta WhatsApp Flows (interactive JSON), not Engagive Automations. Optional status filter.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/flows
Example success response (JSON)
{
  "success": true,
  "statusCode": 200,
  "data": [
    {
      "id": 10,
      "name": "Order status flow",
      "wa_flow_id": "1234567890",
      "wa_status": "PUBLISHED",
      "template_name": "default",
      "updated_at": "2026-08-05T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 10,
    "totalCount": 1,
    "totalPages": 1
  }
}

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
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/flows?page=1&pageSize=10
GET

Get Flow

Required permission: WhatsApp Flows — View

Path
/api/business/public/channels/whatsapp/accounts/:accountId/flows/:id
Example success response (JSON)
{
  "success": true,
  "statusCode": 201,
  "message": "Flow created",
  "data": {
    "id": 10,
    "name": "Order status flow",
    "wa_flow_id": "1234567890",
    "wa_status": "DRAFT",
    "template_name": "default",
    "profile_id": 3
  }
}

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
GET https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/flows/10
POST

Create Flow

Required permission: WhatsApp Flows — Add

Creates a Flow in Engagive and on Meta. name, template_name, and flow_json required. Actor ids default from your API token.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/flows
Example request body (JSON)
{
  "name": "Order status flow",
  "template_name": "default",
  "categories": [
    "OTHER"
  ],
  "flow_json": {
    "version": "3.1",
    "screens": []
  },
  "flow_json_raw": ""
}
Example success response (JSON)
{
  "success": true,
  "statusCode": 201,
  "message": "Flow created",
  "data": {
    "id": 10,
    "name": "Order status flow",
    "wa_flow_id": "1234567890",
    "wa_status": "DRAFT",
    "template_name": "default",
    "profile_id": 3
  }
}

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/flows
PUT

Update Flow JSON

Required permission: WhatsApp Flows — Edit

Path
/api/business/public/channels/whatsapp/accounts/:accountId/flows/:id
Example request body (JSON)
{
  "flow_json": {
    "version": "3.1",
    "screens": []
  },
  "flow_json_raw": ""
}
Example success response (JSON)
{
  "success": true,
  "statusCode": 201,
  "message": "Flow created",
  "data": {
    "id": 10,
    "name": "Order status flow",
    "wa_flow_id": "1234567890",
    "wa_status": "DRAFT",
    "template_name": "default",
    "profile_id": 3
  }
}

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
PUT https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/flows/10
DELETE

Delete Flow

Required permission: WhatsApp Flows — Delete

Path
/api/business/public/channels/whatsapp/accounts/:accountId/flows/:id
Example success response (JSON)
{
  "success": true,
  "message": "Flow deleted",
  "data": null
}

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
DELETE https://api.engagive.io/api/business/public/channels/whatsapp/accounts/1/flows/10