WhatsApp Business API
WhatsApp Templates API — Submit & Manage Templates
Submit, manage, and sync WhatsApp Message Templates via the Vobiz API - Meta-approved formats required for all proactive business-initiated outbound messaging.
GET
/
api
/
v1
/
Account
/
{auth_id}
/
WhatsApp
/
Channel
/
{channelId}
/
Template
/
List templates
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"id": "9d8f1e2a-4c3b-4a1d-8e7f-1a2b3c4d5e6f",
"account_id": "MA_XXXXXXXX",
"channel_id": "0a8f3feb-9598-47f2-8a6c-df1aeb306ae1",
"waba_id": "123456789012345",
"meta_template_id": "1234567890123456",
"name": "order_confirmation",
"language": "en_US",
"category": "UTILITY",
"status": "approved",
"components": [
{
"type": "BODY",
"text": "Your order {{1}} has been confirmed. Delivery: {{2}}"
}
],
"quality_score": "",
"created_at": "2026-10-05T11:39:13Z",
"updated_at": "2026-10-05T16:41:37Z"
}
],
"total": 1,
"page": 1,
"limit": 250,
"has_more": false
}Meta approval required - Templates must be approved by Meta before they can be sent. Newly created templates start with status
pending; approval typically takes a few minutes to 24 hours. Sync templates to pick up Meta’s decision.https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp
Authentication: every request needs the X-Auth-ID: MA_XXXXXXXX and X-Auth-Token: YOUR_AUTH_TOKEN headers, and the {auth_id} in the path must be the account those credentials belong to. Set Content-Type: application/json on requests with a JSON body. Get your credentials from console.vobiz.ai.
The {channelId} path parameter is the id (UUID) of the channel the templates belong to, as returned by the Channels API.
Template create and list are always scoped to a channel under
/Channel/{channelId}/Template/.Template categories
| Category | Use case |
|---|---|
UTILITY | Transactional - orders, receipts, alerts |
MARKETING | Promotional - offers, announcements |
AUTHENTICATION | OTP and security codes only |
List templates
GET https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/
| Query param | Description |
|---|---|
status | Return only templates with this status. Statuses are lowercase and the match is exact, so send approved, not APPROVED. |
cURL
curl -X GET \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Channel/{channelId}/Template/?status=approved" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
200 OK
{
"items": [
{
"id": "9d8f1e2a-4c3b-4a1d-8e7f-1a2b3c4d5e6f",
"account_id": "MA_XXXXXXXX",
"channel_id": "0a8f3feb-9598-47f2-8a6c-df1aeb306ae1",
"waba_id": "123456789012345",
"meta_template_id": "1234567890123456",
"name": "order_confirmation",
"language": "en_US",
"category": "UTILITY",
"status": "approved",
"components": [
{ "type": "BODY", "text": "Your order {{1}} has been confirmed. Delivery: {{2}}" }
],
"quality_score": "",
"created_at": "2026-10-05T11:39:13Z",
"updated_at": "2026-10-05T16:41:37Z"
}
],
"total": 1,
"page": 1,
"limit": 250,
"has_more": false
}
Create template
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/
pending. The request body uses Meta’s component format. Use double-brace numbered placeholders like {{1}}, {{2}} for dynamic content in the BODY. If Meta rejects the template, the request returns 400 with Meta’s message. Returns 201 Created.
Request body
| Field | Required | Description |
|---|---|---|
name | Yes | Template name, lowercase_snake_case |
language | Yes | Language code (e.g. en_US) |
category | Yes | MARKETING, UTILITY, or AUTHENTICATION |
components | No | Array of component objects (Meta format) |
| Field | Description |
|---|---|
type | HEADER, BODY, FOOTER, or BUTTONS |
format | Optional. TEXT, IMAGE, VIDEO, or DOCUMENT (for HEADER) |
text | Component text. BODY text may use {{1}}, {{2}} placeholders |
buttons | Array of { type, text, url?, phone_number? }. type is QUICK_REPLY, URL, or PHONE_NUMBER |
example | Sample values: { "header_handle": [], "body_text": [[]] }. A media HEADER needs header_handle from Upload a header sample. |
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Channel/{channelId}/Template/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "order_confirmation",
"language": "en_US",
"category": "UTILITY",
"components": [
{
"type": "BODY",
"text": "Your order {{1}} has been confirmed. Delivery: {{2}}",
"example": { "body_text": [["ORD-12345", "March 15"]] }
},
{
"type": "BUTTONS",
"buttons": [
{ "type": "URL", "text": "Track order", "url": "https://example.com/track" }
]
}
]
}'
201 Created
{
"id": "9d8f1e2a-4c3b-4a1d-8e7f-1a2b3c4d5e6f",
"account_id": "MA_XXXXXXXX",
"channel_id": "0a8f3feb-9598-47f2-8a6c-df1aeb306ae1",
"waba_id": "123456789012345",
"meta_template_id": "1234567890123456",
"name": "order_confirmation",
"language": "en_US",
"category": "UTILITY",
"status": "pending",
"components": [
{
"type": "BODY",
"text": "Your order {{1}} has been confirmed. Delivery: {{2}}",
"example": { "body_text": [["ORD-12345", "March 15"]] }
},
{
"type": "BUTTONS",
"buttons": [
{ "type": "URL", "text": "Track order", "url": "https://example.com/track" }
]
}
],
"quality_score": "",
"created_at": "2026-10-05T11:39:13Z",
"updated_at": "2026-10-05T11:39:13Z"
}
Upload a header sample
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Template/HeaderHandle/
IMAGE, VIDEO, or DOCUMENT header, upload sample media first. Send multipart/form-data with a channel_id field and a file field (up to 16 MB). Put the returned handle in the header component’s example.header_handle array when you create the template.
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Template/HeaderHandle/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-F "channel_id=0a8f3feb-9598-47f2-8a6c-df1aeb306ae1" \
-F "file=@/path/to/banner.jpg;type=image/jpeg"
200 OK
{ "handle": "4::aW1hZ2UvanBlZw==:ARZ..." }
Sync templates from Meta
POST https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/Sync/
pending to approved). Returns the number of templates synced. This request takes no request body.
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Channel/{channelId}/Template/Sync/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN"
200 OK
{ "synced": 7 }
Template object
| Field | Type | Description |
|---|---|---|
id | UUID | Vobiz template ID. Pass it as template_id when you create a campaign. |
account_id | string | Owning account (MA_XXXXXXXX) |
channel_id | UUID | Channel the template belongs to |
waba_id | string | Meta WhatsApp Business Account ID |
meta_template_id | string | Meta’s template ID |
name | string | Template name (lowercase_snake_case) |
language | string | Language code (e.g. en_US) |
category | string | Uppercase category, for example MARKETING, UTILITY, or AUTHENTICATION |
status | string | Meta review status in lowercase, for example approved, pending, or rejected. Only approved templates can be used in campaigns. |
components | array | The template’s components in Meta’s format |
quality_score | string | Meta quality rating, for example GREEN. Empty until Meta reports one. |
created_at | RFC3339 | Creation timestamp (UTC) |
updated_at | RFC3339 | Last update timestamp (UTC) |
Sending a template message
Creating a template does not send anything. To send an approved template, use the Messages API withtype: "template".
cURL
curl -X POST \
"https://api.vobiz.ai/api/v1/Account/MA_XXXXXXXX/WhatsApp/Message/" \
-H "X-Auth-ID: MA_XXXXXXXX" \
-H "X-Auth-Token: YOUR_AUTH_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"channel_id": "{channelId}",
"to": "+919876543210",
"type": "template",
"template": {
"name": "order_confirmation",
"language": { "code": "en_US" },
"category": "utility",
"components": [
{
"type": "body",
"parameters": [
{ "type": "text", "text": "ORD-12345" },
{ "type": "text", "text": "March 15" }
]
}
]
}
}'
Authorizations
Path Parameters
Query Parameters
Response
The channel's templates.
Was this page helpful?
⌘I
List templates
curl --request GET \
--url https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/ \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/"
headers = {
"X-Auth-ID": "<api-key>",
"X-Auth-Token": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/WhatsApp/Channel/{channelId}/Template/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"items": [
{
"id": "9d8f1e2a-4c3b-4a1d-8e7f-1a2b3c4d5e6f",
"account_id": "MA_XXXXXXXX",
"channel_id": "0a8f3feb-9598-47f2-8a6c-df1aeb306ae1",
"waba_id": "123456789012345",
"meta_template_id": "1234567890123456",
"name": "order_confirmation",
"language": "en_US",
"category": "UTILITY",
"status": "approved",
"components": [
{
"type": "BODY",
"text": "Your order {{1}} has been confirmed. Delivery: {{2}}"
}
],
"quality_score": "",
"created_at": "2026-10-05T11:39:13Z",
"updated_at": "2026-10-05T16:41:37Z"
}
],
"total": 1,
"page": 1,
"limit": 250,
"has_more": false
}