Engagive API documentation

Channels · WhatsApp · Templates

Template Lookups

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.

Lookups return codes you need when creating templates. Call them with the same bearer token and account id as other public APIs.

GET

Lookups — Categories

Required permission: WhatsApp Templates — View

Returns category codes and labels. Use these with options and parameter-format lookups when creating a template.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates/lookups/categories
Example success response (JSON)
{
  "success": true,
  "message": "Categories retrieved",
  "data": [
    {
      "code": "MARKETING",
      "label": "Marketing"
    },
    {
      "code": "UTILITY",
      "label": "Utility"
    }
  ]
}

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/lookups/categories
GET

Lookups — Category options

Required permission: WhatsApp Templates — View

Returns valid option_code values for the given category_code.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates/lookups/categories/:categoryCode/options
Example success response (JSON)
{
  "success": true,
  "message": "Options retrieved",
  "data": [
    {
      "code": "STANDARD",
      "label": "Standard message",
      "category_code": "MARKETING"
    }
  ]
}

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/lookups/categories/marketing/options
GET

Lookups — Parameter formats

Required permission: WhatsApp Templates — View

Returns parameter_format_code values (e.g. `number` vs `name`) for create template.

Path
/api/business/public/channels/whatsapp/accounts/:accountId/templates/lookups/parameter-formats
Example success response (JSON)
{
  "success": true,
  "message": "Parameter formats retrieved",
  "data": [
    {
      "code": "POSITIONAL",
      "label": "Positional parameters"
    },
    {
      "code": "NAMED",
      "label": "Named parameters"
    }
  ]
}

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/lookups/parameter-formats