> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zatten.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Envia uma mensagem de template

> Inicia uma conversa ou envia uma notificação para um lead utilizando um template pré-aprovado do WhatsApp. Se o lead com o `lead_number` informado não existir, um novo será criado no sistema.



## OpenAPI

````yaml /api-reference/zattenapi.json post /messages/template
openapi: 3.1.0
info:
  title: API de Atendimento e Mensageria
  description: >-
    API para interagir com o sistema de atendimento, permitindo o envio de
    mensagens via template do WhatsApp e a gestão de informações de leads. A
    autenticação é realizada através de uma chave de API (`x-api-key`) enviada
    no cabeçalho de cada requisição. A API também possui um sistema de limite de
    requisições (rate limiting) para garantir a estabilidade.
  version: 1.0.0
servers:
  - url: https://api.zatten.com/api/v1
security:
  - ApiKeyAuth: []
tags:
  - name: Mensagens
    description: Endpoints para envio e consulta de mensagens.
  - name: Leads
    description: Endpoints para gerenciamento de dados de leads.
  - name: Kanban
    description: Endpoints para consulta de estruturas de organização do CRM.
  - name: Tags
    description: Endpoints para consulta de etiquetas (tags) de organização.
paths:
  /messages/template:
    post:
      tags:
        - Mensagens
      summary: Envia uma mensagem de template
      description: >-
        Inicia uma conversa ou envia uma notificação para um lead utilizando um
        template pré-aprovado do WhatsApp. Se o lead com o `lead_number`
        informado não existir, um novo será criado no sistema.
      requestBody:
        description: Dados necessários para o envio do template.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendTemplateMessageRequest'
      responses:
        '201':
          description: Mensagem enviada com sucesso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendMessageResponse'
        '400':
          description: Erro de validação nos dados da requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Chave de API (`x-api-key`) ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Limite de requisições excedido. Tente novamente mais tarde.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    SendTemplateMessageRequest:
      type: object
      required:
        - lead_number
        - template_name
      properties:
        lead_number:
          type: string
          description: Número de WhatsApp do destinatário (lead).
        template_name:
          type: string
          description: Nome do template a ser enviado.
        name:
          type: string
          description: Nome do lead, utilizado caso o lead precise ser criado.
    SendMessageResponse:
      type: object
      properties:
        wa_id:
          type: string
          description: O ID do WhatsApp (WaId) do lead que recebeu a mensagem.
        name:
          type: string
          description: O nome do lead.
        thread_id:
          type: string
          description: O ID da thread de conversa associada ao lead.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Descrição do erro ocorrido.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Chave de API necessária para autenticar todas as requisições.

````