Engagive API documentation

Channels · WhatsApp · Templates

Template APIs

Base URL & auth

  • Prefix: /api/business/public on https://stage.api.engagive.io (full base: https://stage.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.

Templates are identified by stable template code in the URL (not numeric ids). Create uses lookup codes; update via public API is not exposed—use the business portal to change category/option/format if needed.

GET

List templates

Required permission: WhatsApp Templates — View

Lists templates for the account. Optional search query filters by name/code.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates
Example success response (JSON)
{
  "success": true,
  "message": "Templates retrieved",
  "data": [
    {
      "id": 101,
      "code": "order_shipped",
      "name": "Order shipped",
      "category_code": "UTILITY",
      "option_code": "STANDARD",
      "parameter_format_code": "POSITIONAL",
      "status": "approved"
    }
  ]
}

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://stage.api.engagive.io/api/business/public/channels/whatsapp/accounts/1/templates
GET

Get template by code

Required permission: WhatsApp Templates — View

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates/:templateCode
Example success response (JSON)
{
  "success": true,
  "message": "Template retrieved",
  "data": {
    "id": 101,
    "code": "order_shipped",
    "name": "Order shipped",
    "category_code": "UTILITY",
    "option_code": "STANDARD",
    "parameter_format_code": "POSITIONAL",
    "status": "approved"
  }
}

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://stage.api.engagive.io/api/business/public/channels/whatsapp/accounts/1/templates/order_shipped
POST

Create template

Required permission: WhatsApp Templates — Add

Same route for every template type — change category_code, option_code, and parameter_format_code from lookups. There is no public PUT to update a template.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates
Example request body (JSON)
{
  "code": "order_update",
  "category_code": "marketing",
  "option_code": "default",
  "parameter_format_code": "number"
}
Example success response (JSON)
{
  "success": true,
  "message": "Template retrieved",
  "data": {
    "id": 101,
    "code": "order_shipped",
    "name": "Order shipped",
    "category_code": "UTILITY",
    "option_code": "STANDARD",
    "parameter_format_code": "POSITIONAL",
    "status": "approved"
  }
}

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

Delete template

Required permission: WhatsApp Templates — Delete

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates/:templateCode
Example success response (JSON)
{
  "success": true,
  "message": "Template 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://stage.api.engagive.io/api/business/public/channels/whatsapp/accounts/1/templates/order_shipped