Criar template
curl --request POST \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"language": "<string>",
"message_send_ttl_seconds": 123,
"allow_category_change": true,
"library_template_name": "<string>",
"library_template_body_inputs": [
{
"add_contact_number": true,
"add_learn_more_link": true,
"add_security_recommendation": true,
"add_track_package_link": true,
"code_expiration_minutes": 45
}
],
"library_template_button_inputs": [
{
"url": {
"base_url": "<string>",
"url_suffix_example": "<string>"
},
"phone_number": "<string>"
}
],
"components": [
{
"text": "<string>",
"example": {
"body_text": [
[
"<string>"
]
],
"body_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_text": [
"<string>"
],
"header_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_handle": [
"<string>"
]
},
"add_security_recommendation": true,
"code_expiration_minutes": 45,
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>",
"example": "<string>",
"supported_apps": [
{
"package_name": "<string>",
"signature_hash": "<string>"
}
],
"zero_tap_terms_accepted": true,
"flow_id": "<string>",
"flow_name": "<string>",
"flow_json": "<string>",
"navigate_screen": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
],
"limited_time_offer": {
"text": "<string>",
"has_expiration": true
}
}
]
}
'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates"
payload = {
"name": "<string>",
"language": "<string>",
"message_send_ttl_seconds": 123,
"allow_category_change": True,
"library_template_name": "<string>",
"library_template_body_inputs": [
{
"add_contact_number": True,
"add_learn_more_link": True,
"add_security_recommendation": True,
"add_track_package_link": True,
"code_expiration_minutes": 45
}
],
"library_template_button_inputs": [
{
"url": {
"base_url": "<string>",
"url_suffix_example": "<string>"
},
"phone_number": "<string>"
}
],
"components": [
{
"text": "<string>",
"example": {
"body_text": [["<string>"]],
"body_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_text": ["<string>"],
"header_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_handle": ["<string>"]
},
"add_security_recommendation": True,
"code_expiration_minutes": 45,
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>",
"example": "<string>",
"supported_apps": [
{
"package_name": "<string>",
"signature_hash": "<string>"
}
],
"zero_tap_terms_accepted": True,
"flow_id": "<string>",
"flow_name": "<string>",
"flow_json": "<string>",
"navigate_screen": "<string>"
}
],
"cards": [{ "components": "<array>" }],
"limited_time_offer": {
"text": "<string>",
"has_expiration": True
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
language: '<string>',
message_send_ttl_seconds: 123,
allow_category_change: true,
library_template_name: '<string>',
library_template_body_inputs: [
{
add_contact_number: true,
add_learn_more_link: true,
add_security_recommendation: true,
add_track_package_link: true,
code_expiration_minutes: 45
}
],
library_template_button_inputs: [
{
url: {base_url: '<string>', url_suffix_example: '<string>'},
phone_number: '<string>'
}
],
components: [
{
text: '<string>',
example: {
body_text: [['<string>']],
body_text_named_params: [{param_name: '<string>', example: '<string>'}],
header_text: ['<string>'],
header_text_named_params: [{param_name: '<string>', example: '<string>'}],
header_handle: ['<string>']
},
add_security_recommendation: true,
code_expiration_minutes: 45,
buttons: [
{
text: '<string>',
url: '<string>',
phone_number: '<string>',
example: '<string>',
supported_apps: [{package_name: '<string>', signature_hash: '<string>'}],
zero_tap_terms_accepted: true,
flow_id: '<string>',
flow_name: '<string>',
flow_json: '<string>',
navigate_screen: '<string>'
}
],
cards: [{components: '<array>'}],
limited_time_offer: {text: '<string>', has_expiration: true}
}
]
})
};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'language' => '<string>',
'message_send_ttl_seconds' => 123,
'allow_category_change' => true,
'library_template_name' => '<string>',
'library_template_body_inputs' => [
[
'add_contact_number' => true,
'add_learn_more_link' => true,
'add_security_recommendation' => true,
'add_track_package_link' => true,
'code_expiration_minutes' => 45
]
],
'library_template_button_inputs' => [
[
'url' => [
'base_url' => '<string>',
'url_suffix_example' => '<string>'
],
'phone_number' => '<string>'
]
],
'components' => [
[
'text' => '<string>',
'example' => [
'body_text' => [
[
'<string>'
]
],
'body_text_named_params' => [
[
'param_name' => '<string>',
'example' => '<string>'
]
],
'header_text' => [
'<string>'
],
'header_text_named_params' => [
[
'param_name' => '<string>',
'example' => '<string>'
]
],
'header_handle' => [
'<string>'
]
],
'add_security_recommendation' => true,
'code_expiration_minutes' => 45,
'buttons' => [
[
'text' => '<string>',
'url' => '<string>',
'phone_number' => '<string>',
'example' => '<string>',
'supported_apps' => [
[
'package_name' => '<string>',
'signature_hash' => '<string>'
]
],
'zero_tap_terms_accepted' => true,
'flow_id' => '<string>',
'flow_name' => '<string>',
'flow_json' => '<string>',
'navigate_screen' => '<string>'
]
],
'cards' => [
[
'components' => '<array>'
]
],
'limited_time_offer' => [
'text' => '<string>',
'has_expiration' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "1613165359891625",
"status": "PENDING",
"category": "UTILITY"
}{
"error": {
"timestamp": "2026-10-19T12:00:00Z",
"status": 422,
"errors": [
{
"description": "",
"name": "META_WHATSAPP_ERROR",
"message": "Sua mensagem não pode ser enviada pois ela tem conteúdo que outras pessoas no Facebook denunciaram como abusivo.",
"code": "368"
}
]
}
}{
"error": 401,
"message": "Unauthorized"
}{
"error": {
"errors": [
{
"code": "100",
"name": "META_WHATSAPP_ERROR",
"subCode": "2388024",
"message": "Invalid parameter",
"description": "There is already Portuguese (BR) content for this template. You can create a new template and try again."
}
]
}
}{
"error": "integration_unavailable",
"message": "The operation could not be completed right now. Try again in a few moments."
}{
"error": "outcome_unknown",
"message": "The operation did not finish in time and may still be completed. Check the result before trying again."
}Criar template
Referência da API
A chamada que cria o template: rota, autenticação, respostas e erros
POST
/
whatsapp
/
businesses
/
{wabaId}
/
templates
Criar template
curl --request POST \
--url https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"language": "<string>",
"message_send_ttl_seconds": 123,
"allow_category_change": true,
"library_template_name": "<string>",
"library_template_body_inputs": [
{
"add_contact_number": true,
"add_learn_more_link": true,
"add_security_recommendation": true,
"add_track_package_link": true,
"code_expiration_minutes": 45
}
],
"library_template_button_inputs": [
{
"url": {
"base_url": "<string>",
"url_suffix_example": "<string>"
},
"phone_number": "<string>"
}
],
"components": [
{
"text": "<string>",
"example": {
"body_text": [
[
"<string>"
]
],
"body_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_text": [
"<string>"
],
"header_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_handle": [
"<string>"
]
},
"add_security_recommendation": true,
"code_expiration_minutes": 45,
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>",
"example": "<string>",
"supported_apps": [
{
"package_name": "<string>",
"signature_hash": "<string>"
}
],
"zero_tap_terms_accepted": true,
"flow_id": "<string>",
"flow_name": "<string>",
"flow_json": "<string>",
"navigate_screen": "<string>"
}
],
"cards": [
{
"components": "<array>"
}
],
"limited_time_offer": {
"text": "<string>",
"has_expiration": true
}
}
]
}
'import requests
url = "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates"
payload = {
"name": "<string>",
"language": "<string>",
"message_send_ttl_seconds": 123,
"allow_category_change": True,
"library_template_name": "<string>",
"library_template_body_inputs": [
{
"add_contact_number": True,
"add_learn_more_link": True,
"add_security_recommendation": True,
"add_track_package_link": True,
"code_expiration_minutes": 45
}
],
"library_template_button_inputs": [
{
"url": {
"base_url": "<string>",
"url_suffix_example": "<string>"
},
"phone_number": "<string>"
}
],
"components": [
{
"text": "<string>",
"example": {
"body_text": [["<string>"]],
"body_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_text": ["<string>"],
"header_text_named_params": [
{
"param_name": "<string>",
"example": "<string>"
}
],
"header_handle": ["<string>"]
},
"add_security_recommendation": True,
"code_expiration_minutes": 45,
"buttons": [
{
"text": "<string>",
"url": "<string>",
"phone_number": "<string>",
"example": "<string>",
"supported_apps": [
{
"package_name": "<string>",
"signature_hash": "<string>"
}
],
"zero_tap_terms_accepted": True,
"flow_id": "<string>",
"flow_name": "<string>",
"flow_json": "<string>",
"navigate_screen": "<string>"
}
],
"cards": [{ "components": "<array>" }],
"limited_time_offer": {
"text": "<string>",
"has_expiration": True
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
language: '<string>',
message_send_ttl_seconds: 123,
allow_category_change: true,
library_template_name: '<string>',
library_template_body_inputs: [
{
add_contact_number: true,
add_learn_more_link: true,
add_security_recommendation: true,
add_track_package_link: true,
code_expiration_minutes: 45
}
],
library_template_button_inputs: [
{
url: {base_url: '<string>', url_suffix_example: '<string>'},
phone_number: '<string>'
}
],
components: [
{
text: '<string>',
example: {
body_text: [['<string>']],
body_text_named_params: [{param_name: '<string>', example: '<string>'}],
header_text: ['<string>'],
header_text_named_params: [{param_name: '<string>', example: '<string>'}],
header_handle: ['<string>']
},
add_security_recommendation: true,
code_expiration_minutes: 45,
buttons: [
{
text: '<string>',
url: '<string>',
phone_number: '<string>',
example: '<string>',
supported_apps: [{package_name: '<string>', signature_hash: '<string>'}],
zero_tap_terms_accepted: true,
flow_id: '<string>',
flow_name: '<string>',
flow_json: '<string>',
navigate_screen: '<string>'
}
],
cards: [{components: '<array>'}],
limited_time_offer: {text: '<string>', has_expiration: true}
}
]
})
};
fetch('https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'language' => '<string>',
'message_send_ttl_seconds' => 123,
'allow_category_change' => true,
'library_template_name' => '<string>',
'library_template_body_inputs' => [
[
'add_contact_number' => true,
'add_learn_more_link' => true,
'add_security_recommendation' => true,
'add_track_package_link' => true,
'code_expiration_minutes' => 45
]
],
'library_template_button_inputs' => [
[
'url' => [
'base_url' => '<string>',
'url_suffix_example' => '<string>'
],
'phone_number' => '<string>'
]
],
'components' => [
[
'text' => '<string>',
'example' => [
'body_text' => [
[
'<string>'
]
],
'body_text_named_params' => [
[
'param_name' => '<string>',
'example' => '<string>'
]
],
'header_text' => [
'<string>'
],
'header_text_named_params' => [
[
'param_name' => '<string>',
'example' => '<string>'
]
],
'header_handle' => [
'<string>'
]
],
'add_security_recommendation' => true,
'code_expiration_minutes' => 45,
'buttons' => [
[
'text' => '<string>',
'url' => '<string>',
'phone_number' => '<string>',
'example' => '<string>',
'supported_apps' => [
[
'package_name' => '<string>',
'signature_hash' => '<string>'
]
],
'zero_tap_terms_accepted' => true,
'flow_id' => '<string>',
'flow_name' => '<string>',
'flow_json' => '<string>',
'navigate_screen' => '<string>'
]
],
'cards' => [
[
'components' => '<array>'
]
],
'limited_time_offer' => [
'text' => '<string>',
'has_expiration' => true
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omni.z-api.io/whatsapp/businesses/{wabaId}/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"language\": \"<string>\",\n \"message_send_ttl_seconds\": 123,\n \"allow_category_change\": true,\n \"library_template_name\": \"<string>\",\n \"library_template_body_inputs\": [\n {\n \"add_contact_number\": true,\n \"add_learn_more_link\": true,\n \"add_security_recommendation\": true,\n \"add_track_package_link\": true,\n \"code_expiration_minutes\": 45\n }\n ],\n \"library_template_button_inputs\": [\n {\n \"url\": {\n \"base_url\": \"<string>\",\n \"url_suffix_example\": \"<string>\"\n },\n \"phone_number\": \"<string>\"\n }\n ],\n \"components\": [\n {\n \"text\": \"<string>\",\n \"example\": {\n \"body_text\": [\n [\n \"<string>\"\n ]\n ],\n \"body_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_text\": [\n \"<string>\"\n ],\n \"header_text_named_params\": [\n {\n \"param_name\": \"<string>\",\n \"example\": \"<string>\"\n }\n ],\n \"header_handle\": [\n \"<string>\"\n ]\n },\n \"add_security_recommendation\": true,\n \"code_expiration_minutes\": 45,\n \"buttons\": [\n {\n \"text\": \"<string>\",\n \"url\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"example\": \"<string>\",\n \"supported_apps\": [\n {\n \"package_name\": \"<string>\",\n \"signature_hash\": \"<string>\"\n }\n ],\n \"zero_tap_terms_accepted\": true,\n \"flow_id\": \"<string>\",\n \"flow_name\": \"<string>\",\n \"flow_json\": \"<string>\",\n \"navigate_screen\": \"<string>\"\n }\n ],\n \"cards\": [\n {\n \"components\": \"<array>\"\n }\n ],\n \"limited_time_offer\": {\n \"text\": \"<string>\",\n \"has_expiration\": true\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "1613165359891625",
"status": "PENDING",
"category": "UTILITY"
}{
"error": {
"timestamp": "2026-10-19T12:00:00Z",
"status": 422,
"errors": [
{
"description": "",
"name": "META_WHATSAPP_ERROR",
"message": "Sua mensagem não pode ser enviada pois ela tem conteúdo que outras pessoas no Facebook denunciaram como abusivo.",
"code": "368"
}
]
}
}{
"error": 401,
"message": "Unauthorized"
}{
"error": {
"errors": [
{
"code": "100",
"name": "META_WHATSAPP_ERROR",
"subCode": "2388024",
"message": "Invalid parameter",
"description": "There is already Portuguese (BR) content for this template. You can create a new template and try again."
}
]
}
}{
"error": "integration_unavailable",
"message": "The operation could not be completed right now. Try again in a few moments."
}{
"error": "outcome_unknown",
"message": "The operation did not finish in time and may still be completed. Check the result before trying again."
}Esta é a chamada única de criação. O corpo dela é o JSON do modelo que você escolheu — não existe rota separada por modelo, e mandar o payload de Modelos já cria o template.
Aqui ficam a mecânica e o retorno: a rota, o
wabaId, o schema campo a campo e o que volta em cada caso. O playground acima dispara a chamada de verdade.
O template nasce com status PENDING e passa a APPROVED ou REJECTED depois da revisão da Meta. Use Sincronizar templates para forçar a atualização do status.
O
wabaId sai do endpoint de Listar WABAs.O nome vai em
snake_case, sem espaço nem caractere especial, e não pode ser alterado depois de criado.Este endpoint é escopado por WABA, então hoje cobre só o Meta Cloud API.Instagram e Messenger também têm template pré-aprovado — o Utility Template, escopado por página. O suporte a eles no Omni Z-API está em implementação. Veja a comparação dos três tipos de template.
Escolher o modelo
Os 13 modelos e qual usar
Campos do template
Para que serve cada campo
Validações
O que a Meta recusa
Autorizações
Secret Key gerada no painel de Segurança do Omni Z-API
Parâmetros de caminho
ID do WABA (obtido via Listar WABAs)
Exemplo:
"428083093730937"
Corpo
application/json
Nome do template: minúsculas, números e sublinhado. Não pode ser alterado depois de criado.
Maximum string length:
512Pattern:
^[a-z0-9_]+$Vários tipos têm categoria fixa. Ver "Tipos de template".
Opções disponíveis:
UTILITY, MARKETING, AUTHENTICATION Idioma no formato da Meta, como pt_BR ou en_US.
Sintaxe das variáveis. Nomeado é o formato atual da Meta.
Opções disponíveis:
NAMED, POSITIONAL Validade do envio em segundos. Faixa por categoria: autenticação 30 a 900, marketing 43200 a 2592000, utility 30 a 43200. O valor -1 é atalho de 30 dias.
Permite que a Meta recategorize o template na revisão.
Nome do modelo na biblioteca da Meta. Ver "Template Library".
Ajustes de corpo que o modelo da biblioteca aceita.
Show child attributes
Show child attributes
Dados dos botões do modelo da biblioteca.
Show child attributes
Show child attributes
Cada item é um componente, identificado pelo campo type. Os campos abaixo pertencem a um type específico, e o que cada tipo de template aceita está em "Tipos de template".
Show child attributes
Show child attributes