📋 Templates WABA

SendTemplateWaba

post

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

numberstringOpcional

Número do WhatsApp do destinatário (formato: 5511999999999)

Example: 5515998566622

isClosedbooleanOpcional

Define se o ticket será fechado após o envio

Example: false

validateNumberbooleanOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/v2/api/external/{apiId}/template

POST /v2/api/external/{apiId}/template HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "number": "5515998566622",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5515998566622",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": {
        "code": "en_US"
      }
    }
  },
  "validateNumber": true
}

{}

SendTemplateWabaBody

post

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

numberstringOpcional

Número do WhatsApp do destinatário (formato: 5511999999999)

Example: 5515998566622

isClosedbooleanOpcional

Define se o ticket será fechado após o envio

Example: false

validateNumberbooleanOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/v2/api/external/{apiId}/templateBody

POST /v2/api/external/{apiId}/templateBody HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "number": "5515998566622",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5515998566622",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": {
        "code": "en_US"
      }
    }
  },
  "validateNumber": true
}

{}

SendTemplateWabaMarketing

post

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

Autorizações

AuthorizationstringObrigatório

Token da API do tenant (na coleção Postman: BearerToken).

Parâmetros de rota

apiIdstringObrigatório

ID da API externa cadastrada no Z-PRO.

Corpo

numberstringOpcional

Número do WhatsApp do destinatário (formato: 5511999999999)

Example: 5515998566622

isClosedbooleanOpcional

Define se o ticket será fechado após o envio

Example: false

validateNumberbooleanOpcional

Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado

Example: true

Respostas

200

Requisição processada com sucesso.

application/json

objectOpcional

400

Parâmetros inválidos ou faltando.

401

Token ausente, inválido ou sem permissão.

post/v2/api/external/{apiId}/templateMarketingBody

POST /v2/api/external/{apiId}/templateMarketingBody HTTP/1.1
Host: api.seudominio.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 214

{
  "number": "5515998566622",
  "isClosed": false,
  "templateData": {
    "messaging_product": "whatsapp",
    "to": "5515998566622",
    "type": "template",
    "template": {
      "name": "hello_world",
      "language": {
        "code": "en_US"
      }
    }
  },
  "validateNumber": true
}

{}