Templates
Atualizar template
Atualiza um template existente (pelo id ou nome) no escopo do número vinculado. O corpo segue o mesmo contrato de Criar template: body como OBJETO { header?, body, footer?, buttons? } (recomendado), o mesmo JSON como STRING ou TEXTO PURO; header NONE | TEXT (0–1 variável, até 60) | IMAGE | VIDEO | DOCUMENT (mídia via header.url OU header.base64 re-hospedado); body.text até 1024 (variáveis {{nome}}, sem começar/terminar com variável); footer até 60 sem variáveis; até 10 buttons — QUICK_REPLY (≤ 10), URL (≤ 2; estática ou dinâmica com uma variável nomeada como {{link}} no fim + example), PHONE_NUMBER (≤ 1), COPY_CODE (≤ 1; código em button.example). O campo examples é OBRIGATÓRIO quando há variáveis; faltando → 400 { code: "TEMPLATE_EXAMPLES_REQUIRED", details: { missing: [...] } }. Para números Meta a nova versão é re-submetida à Meta para aprovação (metaStatus PENDING); 400 META_TEMPLATE_SUBMIT_FAILED se a Meta recusar. 409 TEMPLATE_NOT_EDITABLE se a Meta não permitir editar o template no estado atual (só templates rejeitados podem ser editados); quando a Meta recusa uma edição por qualquer motivo, o template guardado fica inalterado. 404 TEMPLATE_NOT_FOUND se não existir no escopo do número. Requer key escopada a número.
**Requer uma chave com escopo de número.**
PUT
/
v1
/
templates
/
{id}
Atualizar template
curl --request PUT \
--url https://pilotstatus.com.br/v1/templates/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"body": {
"body": {
"text": "Oi {{nome}}!"
}
},
"body.header": {
"type": "IMAGE",
"url": "https://cdn.loja.com/promo.png"
},
"body.footer": {
"text": "Promoção por tempo limitado"
},
"body.buttons": [
{
"type": "QUICK_REPLY",
"text": "Quero!"
},
{
"type": "URL",
"text": "Comprar",
"url": "https://loja.com/promo/{{link}}"
}
],
"examples": {
"nome": "Maria",
"desconto": "15%",
"link": "abc123"
},
"category": "MARKETING",
"language": "pt_BR"
}
'import requests
url = "https://pilotstatus.com.br/v1/templates/{id}"
payload = {
"body": { "body": { "text": "Oi {{nome}}!" } },
"body.header": {
"type": "IMAGE",
"url": "https://cdn.loja.com/promo.png"
},
"body.footer": { "text": "Promoção por tempo limitado" },
"body.buttons": [
{
"type": "QUICK_REPLY",
"text": "Quero!"
},
{
"type": "URL",
"text": "Comprar",
"url": "https://loja.com/promo/{{link}}"
}
],
"examples": {
"nome": "Maria",
"desconto": "15%",
"link": "abc123"
},
"category": "MARKETING",
"language": "pt_BR"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify({body: JSON.stringify({text: 'Oi {{nome}}!'})}),
'body.header': {type: 'IMAGE', url: 'https://cdn.loja.com/promo.png'},
'body.footer': {text: 'Promoção por tempo limitado'},
'body.buttons': [
{type: 'QUICK_REPLY', text: 'Quero!'},
{type: 'URL', text: 'Comprar', url: 'https://loja.com/promo/{{link}}'}
],
examples: {nome: 'Maria', desconto: '15%', link: 'abc123'},
category: 'MARKETING',
language: 'pt_BR'
})
};
fetch('https://pilotstatus.com.br/v1/templates/{id}', 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://pilotstatus.com.br/v1/templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'body' => [
'body' => [
'text' => 'Oi {{nome}}!'
]
],
'body.header' => [
'type' => 'IMAGE',
'url' => 'https://cdn.loja.com/promo.png'
],
'body.footer' => [
'text' => 'Promoção por tempo limitado'
],
'body.buttons' => [
[
'type' => 'QUICK_REPLY',
'text' => 'Quero!'
],
[
'type' => 'URL',
'text' => 'Comprar',
'url' => 'https://loja.com/promo/{{link}}'
]
],
'examples' => [
'nome' => 'Maria',
'desconto' => '15%',
'link' => 'abc123'
],
'category' => 'MARKETING',
'language' => 'pt_BR'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/templates/{id}"
payload := strings.NewReader("{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://pilotstatus.com.br/v1/templates/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}"
response = http.request(request)
puts response.read_body{
"id": "tpl_01HZX...",
"name": "promo_cupom",
"category": "MARKETING",
"metaStatus": "PENDING"
}
Autorizações
apiKeyapiKeyId
Sua chave de API ps_
Parâmetros de caminho
Id ou nome do template a atualizar.
Corpo
application/json
Novo conteúdo do template: objeto { header?, body, footer?, buttons? } (recomendado), o mesmo JSON como string, ou texto puro (embrulhado automaticamente).
Exemplo:
{ "body": { "text": "Oi {{nome}}!" } }
Cabeçalho opcional. TEXT: text com 0–1 variável (até 60 caracteres). IMAGE/VIDEO/DOCUMENT: informe url (http/https) OU base64 (data URI); base64 é re-hospedado no servidor. Sem cabeçalho de localização.
Exemplo:
{ "type": "IMAGE", "url": "https://cdn.loja.com/promo.png" }
Rodapé opcional, até 60 caracteres, sem variáveis.
Exemplo:
{ "text": "Promoção por tempo limitado" }
Até 10 botões: QUICK_REPLY (≤ 10; text), URL (≤ 2; text + url estática ou dinâmica com uma variável nomeada no fim, ex.: {{link}}), PHONE_NUMBER (≤ 1; text + phone_number E.164), COPY_CODE (≤ 1; código em example). Quick-reply e CTA podem coexistir.
Show child attributes
Show child attributes
Exemplo:
[ { "type": "QUICK_REPLY", "text": "Quero!" }, { "type": "URL", "text": "Comprar", "url": "https://loja.com/promo/{{link}}" } ]
Obrigatório quando há variáveis: mapeia cada variável usada no body/header (e na URL dinâmica) a um valor de amostra. O código do COPY_CODE vai em button.example, não aqui. Faltando → 400 TEMPLATE_EXAMPLES_REQUIRED.
Show child attributes
Show child attributes
Exemplo:
{ "nome": "Maria", "desconto": "15%", "link": "abc123" }
Categoria do template (padrão UTILITY).
Exemplo:
"MARKETING"
Idioma do template (padrão pt_BR).
Exemplo:
"pt_BR"
Resposta
Atualizar template
Esta página foi útil?
⌘I
Atualizar template
curl --request PUT \
--url https://pilotstatus.com.br/v1/templates/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"body": {
"body": {
"text": "Oi {{nome}}!"
}
},
"body.header": {
"type": "IMAGE",
"url": "https://cdn.loja.com/promo.png"
},
"body.footer": {
"text": "Promoção por tempo limitado"
},
"body.buttons": [
{
"type": "QUICK_REPLY",
"text": "Quero!"
},
{
"type": "URL",
"text": "Comprar",
"url": "https://loja.com/promo/{{link}}"
}
],
"examples": {
"nome": "Maria",
"desconto": "15%",
"link": "abc123"
},
"category": "MARKETING",
"language": "pt_BR"
}
'import requests
url = "https://pilotstatus.com.br/v1/templates/{id}"
payload = {
"body": { "body": { "text": "Oi {{nome}}!" } },
"body.header": {
"type": "IMAGE",
"url": "https://cdn.loja.com/promo.png"
},
"body.footer": { "text": "Promoção por tempo limitado" },
"body.buttons": [
{
"type": "QUICK_REPLY",
"text": "Quero!"
},
{
"type": "URL",
"text": "Comprar",
"url": "https://loja.com/promo/{{link}}"
}
],
"examples": {
"nome": "Maria",
"desconto": "15%",
"link": "abc123"
},
"category": "MARKETING",
"language": "pt_BR"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
body: JSON.stringify({body: JSON.stringify({text: 'Oi {{nome}}!'})}),
'body.header': {type: 'IMAGE', url: 'https://cdn.loja.com/promo.png'},
'body.footer': {text: 'Promoção por tempo limitado'},
'body.buttons': [
{type: 'QUICK_REPLY', text: 'Quero!'},
{type: 'URL', text: 'Comprar', url: 'https://loja.com/promo/{{link}}'}
],
examples: {nome: 'Maria', desconto: '15%', link: 'abc123'},
category: 'MARKETING',
language: 'pt_BR'
})
};
fetch('https://pilotstatus.com.br/v1/templates/{id}', 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://pilotstatus.com.br/v1/templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'body' => [
'body' => [
'text' => 'Oi {{nome}}!'
]
],
'body.header' => [
'type' => 'IMAGE',
'url' => 'https://cdn.loja.com/promo.png'
],
'body.footer' => [
'text' => 'Promoção por tempo limitado'
],
'body.buttons' => [
[
'type' => 'QUICK_REPLY',
'text' => 'Quero!'
],
[
'type' => 'URL',
'text' => 'Comprar',
'url' => 'https://loja.com/promo/{{link}}'
]
],
'examples' => [
'nome' => 'Maria',
'desconto' => '15%',
'link' => 'abc123'
],
'category' => 'MARKETING',
'language' => 'pt_BR'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://pilotstatus.com.br/v1/templates/{id}"
payload := strings.NewReader("{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.put("https://pilotstatus.com.br/v1/templates/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/v1/templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": {\n \"body\": {\n \"text\": \"Oi {{nome}}!\"\n }\n },\n \"body.header\": {\n \"type\": \"IMAGE\",\n \"url\": \"https://cdn.loja.com/promo.png\"\n },\n \"body.footer\": {\n \"text\": \"Promoção por tempo limitado\"\n },\n \"body.buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"Quero!\"\n },\n {\n \"type\": \"URL\",\n \"text\": \"Comprar\",\n \"url\": \"https://loja.com/promo/{{link}}\"\n }\n ],\n \"examples\": {\n \"nome\": \"Maria\",\n \"desconto\": \"15%\",\n \"link\": \"abc123\"\n },\n \"category\": \"MARKETING\",\n \"language\": \"pt_BR\"\n}"
response = http.request(request)
puts response.read_body{
"id": "tpl_01HZX...",
"name": "promo_cupom",
"category": "MARKETING",
"metaStatus": "PENDING"
}