Editar um modelo

POST/v1/numbers/{phone_number_id}/templates/{template_id}

Edita os componentes (e, se quiser, a categoria) de um modelo desta conta. O corpo é o da Meta; a Meta revisa de novo. Os limites de edição são os da Meta.

Requer#

Escopo da chave: Gerenciar webhooks managementComo os escopos funcionam
Recurso do plano: API e webhooks apiVer os planos que incluem
Formato: Próprio do Synergy. Erros em { "error": "…" }.

Parâmetros#

No caminho#

No caminho
Nome	Tipo	Obrigatório	Descrição
phone_number_id	string	obrigatório	O `phone_number_id` do número na Meta (o mesmo da Cloud API). Precisa ser um número ativo da organização da chave.
template_id	string	obrigatório	O id do modelo na Meta. Só modelos da conta do WhatsApp Business do número.

Cabeçalhos#

Cabeçalhos
Nome	Tipo	Obrigatório	Descrição
Authorization	string	obrigatório	Sua chave de API, no formato `Bearer <chave>`. Veja Autenticação.

Corpo#

Tipo de conteúdo: application/json.

Campos do corpo
Nome	Tipo	Obrigatório	Descrição
components	object[]	obrigatório
category	string	opcional	Valores: `MARKETING`, `UTILITY`, `AUTHENTICATION`.
message_send_ttl_seconds	integer	opcional

Respostas#

Respostas
Status	Código	Quando acontece
200	—	Modelo editado
400	100	Corpo acima de 64 KB
401	190	Sem `Authorization: Bearer`, chave malformada ou forjada, chave revogada, ou chave sem acesso a este número
403	200	A chave não tem o escopo `management`
403	1390004	O plano da organização não inclui a API
404	100	O `phone_number_id` não é um número ativo desta organização (ou não tem de 5 a 20 dígitos)
404	100	O modelo não existe, ou é de outra conta do WhatsApp Business que não a deste número
429	130429	Mais de 2000 requisições em 10 s com esta chave neste número (`Retry-After: 10`)
429	130429	O número acabou de recusar por vazão, ou está sobrecarregado: o 429 se repete por 200 ms (`Retry-After: 1`)
429	130429	Mais de 30 escritas de modelos em 60 s com esta chave (`Retry-After: 60`)
503	2	Serviço temporariamente indisponível
Outros	131047	Erro da Meta, como ela mandou

Os erros no formato da Meta trazem o código em error.code. Ver todos os erros.

Corpo da resposta 200#

Campos da resposta 200
Nome	Tipo	Obrigatório	Descrição
success	true	obrigatório

Limites de taxa#

Borda: 2000 requisições a cada 10 s por chave × número (API_EDGE_LIMIT).
Escrita de modelos: 30 requisições a cada 60 s por chave (API_MGMT_LIMIT, o mesmo balde da gestão de webhooks).

Notas#

Número: {phone_number_id} precisa ser um número de WhatsApp ativo que a chave alcança; qualquer outro (inclusive o id de uma conta do Instagram) responde 404 (código 100), sem acordar o número.

Requisição

curl

curl -X POST 'https://api.synergyconnect.com.br/v1/numbers/106540352242922/templates/594425479261596' \
  -H "Authorization: Bearer $SYNERGY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"components":[{"type":"BODY","text":"Olá {{1}}, seu pedido {{2}} está a caminho."}]}'

JavaScript

const res = await fetch('https://api.synergyconnect.com.br/v1/numbers/106540352242922/templates/594425479261596', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.SYNERGY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "components": [
      {
        "type": "BODY",
        "text": "Olá {{1}}, seu pedido {{2}} está a caminho."
      }
    ]
  }),
});
console.log(res.status, await res.json());

Python

import os

import requests

res = requests.post(
    "https://api.synergyconnect.com.br/v1/numbers/106540352242922/templates/594425479261596",
    headers={
        "Authorization": f"Bearer {os.environ['SYNERGY_API_KEY']}",
    },
    json={
        "components": [
            {
                "type": "BODY",
                "text": "Olá {{1}}, seu pedido {{2}} está a caminho.",
            },
        ],
    },
)
print(res.status_code, res.json())

Resposta

200

{
  "success": true
}

400

{
  "error": {
    "message": "(#100) Invalid parameter.",
    "type": "OAuthException",
    "code": 100,
    "error_data": {
      "messaging_product": "whatsapp",
      "details": "The body is too large (64 KB max)."
    },
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

401

{
  "error": {
    "message": "(#190) Invalid OAuth access token.",
    "type": "OAuthException",
    "code": 190,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

403

{
  "error": {
    "message": "(#200) Permissions error: this key does not have access to this resource.",
    "type": "OAuthException",
    "code": 200,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 2 casos com este status; veja a tabela de respostas.

404

{
  "error": {
    "message": "(#100) Unsupported request: object does not exist or this key cannot reach it.",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 2 casos com este status; veja a tabela de respostas.

429

{
  "error": {
    "message": "(#130429) Rate limit hit: the number's message throughput has been reached.",
    "type": "OAuthException",
    "code": 130429,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Há 3 casos com este status; veja a tabela de respostas.

503

{
  "error": {
    "message": "(#2) Service temporarily unavailable.",
    "type": "OAuthException",
    "code": 2,
    "fbtrace_id": "syn-3f9a1c0b"
  }
}

Ficou com dúvida? Escreva para suporte@synergyconnect.com.br.