FireFlo OMNI

Your WhatsApp message templates, with their approval status. Filter by status.

Needs the whatsapp.templates:read scope.

Query parameters

Field	Type	Required	Notes
`status`	string	No	`approved`, `pending`, `rejected`, `paused` or `disabled`.

A template has id, name, language, status (approved, pending, rejected, paused or disabled), category (utility, marketing or authentication), components (its parts as WhatsApp holds them: header, body, footer, buttons) and reason (why it was rejected, or empty). On a number FireFlo hosts for you, you see and change only the templates you submitted.

Request

curl "https://api.fireflo.au/v1/channels/whatsapp/templates?status=approved" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/channels/whatsapp/templates",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
    params={
        "status": "approved",
    },
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/channels/whatsapp/templates?status=approved", {
  headers: {
    Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
  },
});
console.log(response.status, await response.json());

Response

200 OK

{
  "data": [
    {
      "id": "1029384756473829",
      "name": "order_shipped",
      "language": "en",
      "status": "approved",
      "category": "utility",
      "components": [
        {
          "type": "BODY",
          "text": "Hi {{1}}, your order {{2}} has shipped."
        },
        {
          "type": "FOOTER",
          "text": "Acme Retail"
        }
      ],
      "reason": ""
    }
  ]
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
400	`invalid_request`	`status` isn’t one of its values (`field` is `status`).
404	`channel_off`	The account doesn’t have WhatsApp on.
409	`provider_refused`	WhatsApp refused it; the message gives WhatsApp’s reason.
403	`scope_missing`	The key doesn’t have the `whatsapp.templates:read` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.

Overview

Account

Messages

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Webhooks

WhatsApp

SMS

Try it

GET /v1/channels/whatsapp/templates

Query parameters

Request

Response

Errors

​Query parameters

​Request

​Response

​Errors

Query parameters

Request

Response

Errors