List Templates (Service Account)

GET

/v1/whatsapp/service-account/templates

Lists every WhatsApp template on the channel's business account with its current status, so callers can check a template is still sendable before calling sendTemplate.

canBeSent is the go/no-go signal. A template deleted in Meta appears here as status: "Deleted" / canBeSent: false instead of failing at send time.

requiredParameters describes what sendTemplate expects for this template.

exampleParameters is shaped exactly like the sendTemplate parameters array. Paste it as-is only when hasPlaceholderValues is false.

A parameter marked autoPopulated is filled in by sendTemplate from the template's own example — omit it, because supplying it suppresses the auto-population.

When usesNamedVariables is true, every value you send for that component must carry the matching name; Meta rejects positional values on a named template.

Trial workspaces share a business account and therefore see only the curated template subset.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://api.voxa.sa/connect/token

Scopes:

VoxaAPI-Access Voxa API as a service account

Query Params

Responses

🟢200

application/json

The channel's template catalogue

Bodyapplication/json

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.voxa.sa/v1/whatsapp/service-account/templates?channelId=3a1........'

Response Example

200 - Success

{
    "name": "vip_invitation",
    "language": "ar",
    "status": "Approved",
    "category": "Utility",
    "canBeSent": true,
    "rejectedReason": null,
    "headerFormat": "IMAGE",
    "bodyText": "أهلاً {{1}}، يسعدنا دعوتك.",
    "requiredParameters": [
        {
            "type": 1,
            "subType": null,
            "index": null,
            "valueType": "image",
            "variableCount": 1,
            "variableNames": [],
            "usesNamedVariables": false,
            "autoPopulated": true
        },
        {
            "type": 2,
            "subType": null,
            "index": null,
            "valueType": "text",
            "variableCount": 1,
            "variableNames": [
                "1"
            ],
            "usesNamedVariables": false,
            "autoPopulated": false
        }
    ],
    "exampleParameters": [
        {
            "type": 2,
            "subType": null,
            "index": null,
            "values": [
                {
                    "type": "text",
                    "name": null,
                    "text": "ريان"
                }
            ]
        }
    ],
    "hasPlaceholderValues": false
}

Modified at 2026-08-04 21:55:33

Send File

Set Property Value on Contact