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

# Enviar template pelo canal

> Envia um template aprovado ao cliente pelo canal e grava a mensagem na conversa, com a janela de resposta aberta ou fechada. Em `parameters.header` e `parameters.body`, informe os valores como lista, na ordem de `parameters.*_names` de Listar templates do canal, ou como objeto nome → valor; em `parameters.buttons`, informe o fim da URL de cada botão dinâmico pela posição dele. Todos os marcadores e botões que o template pede são obrigatórios, e nenhum a mais. Quando o provedor entrega e a gravação falha, a resposta é 201 com `recorded: false` e `media: null` — não reenvie, o cliente já recebeu.



## OpenAPI

````yaml /api-reference/openapi.json post /api/management/channels/{channel}/templates/send
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/channels/{channel}/templates/send:
    parameters:
      - name: channel
        in: path
        required: true
        description: ID (UUID) do canal.
        schema:
          type: string
        example: ''
    post:
      tags:
        - channels
      summary: Enviar template pelo canal
      description: >-
        Envia um template aprovado ao cliente pelo canal e grava a mensagem na
        conversa, com a janela de resposta aberta ou fechada. Em
        `parameters.header` e `parameters.body`, informe os valores como lista,
        na ordem de `parameters.*_names` de Listar templates do canal, ou como
        objeto nome → valor; em `parameters.buttons`, informe o fim da URL de
        cada botão dinâmico pela posição dele. Todos os marcadores e botões que
        o template pede são obrigatórios, e nenhum a mais. Quando o provedor
        entrega e a gravação falha, a resposta é 201 com `recorded: false` e
        `media: null` — não reenvie, o cliente já recebeu.
      requestBody:
        content:
          application/json:
            schema:
              description: Template a enviar e os valores dos marcadores.
              type: object
              properties:
                name:
                  type: string
                  maxLength: 512
                  description: >-
                    Nome do template, como vem em Listar templates do canal (até
                    512 caracteres).
                language:
                  type: string
                  maxLength: 20
                  description: >-
                    Idioma do template, como vem em Listar templates do canal
                    (até 20 caracteres).
                parameters:
                  type: object
                  description: >-
                    Valores do template. Informe exatamente os marcadores e
                    botões que o template pede (campo `parameters` em Listar
                    templates do canal); omita as partes sem marcador.
                  properties:
                    header:
                      description: Valores do cabeçalho; no máximo 1.
                      oneOf:
                        - type: array
                          description: Valores na ordem do template.
                          maxItems: 1
                          items:
                            type: string
                            maxLength: 60
                            description: Valor do marcador (até 60 caracteres).
                        - type: object
                          description: >-
                            Valores por nome do marcador (letras minúsculas,
                            dígitos e `_`, até 60).
                          maxProperties: 1
                          additionalProperties:
                            type: string
                            maxLength: 60
                            description: Valor do marcador (até 60 caracteres).
                          x-propertyNames:
                            pattern: ^[a-z0-9_]{1,60}$
                            description: Nome do marcador.
                    body:
                      description: Valores do corpo; no máximo 100.
                      oneOf:
                        - type: array
                          description: Valores na ordem do template.
                          maxItems: 100
                          items:
                            type: string
                            maxLength: 1024
                            description: Valor do marcador (até 1024 caracteres).
                        - type: object
                          description: >-
                            Valores por nome do marcador (letras minúsculas,
                            dígitos e `_`, até 60).
                          maxProperties: 100
                          additionalProperties:
                            type: string
                            maxLength: 1024
                            description: Valor do marcador (até 1024 caracteres).
                          x-propertyNames:
                            pattern: ^[a-z0-9_]{1,60}$
                            description: Nome do marcador.
                    buttons:
                      type: array
                      maxItems: 10
                      description: >-
                        Sufixo da URL de cada botão dinâmico
                        (`parameters.buttons` em Listar templates do canal); no
                        máximo 10.
                      items:
                        type: object
                        description: Valor de um botão de URL dinâmica.
                        properties:
                          index:
                            type: integer
                            minimum: 0
                            maximum: 9
                            description: Posição do botão no template (0 a 9), sem repetir.
                          value:
                            type: string
                            maxLength: 2000
                            description: >-
                              Texto que substitui `{{1}}` na URL do botão (até
                              2000 caracteres).
                        required:
                          - index
                          - value
                        additionalProperties: false
                  additionalProperties: false
              required:
                - name
                - language
              additionalProperties: false
            example:
              name: inscricao_confirmada
              language: pt_BR
              parameters:
                body:
                  nome: Cliente
                  evento: Evento Exemplo
                  data: 20/11
                buttons:
                  - index: 0
                    value: evento-123
      responses:
        '201':
          description: Sucesso
          content:
            application/json:
              schema:
                description: Resposta com o template enviado e gravado na conversa.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `true` em caso de sucesso.
                  media:
                    type: object
                    description: >-
                      Mensagem gravada na conversa com o texto do template já
                      preenchido; `null` quando o template foi entregue e não
                      pôde ser gravado.
                    properties:
                      id:
                        type: string
                        description: ID (UUID) do conteúdo.
                        format: uuid
                      name:
                        type: string
                        description: Nome interno do conteúdo.
                      technical_name:
                        type: string
                        description: Nome técnico do conteúdo.
                      type:
                        type: integer
                        description: Tipo do conteúdo; `1` = texto.
                      extension:
                        type: string
                        description: Extensão do arquivo; `null` em texto.
                      text:
                        type: string
                        description: >-
                          Texto como o cliente lê: cabeçalho, corpo e rodapé do
                          template, com os marcadores preenchidos.
                      file_url:
                        type: string
                        description: Endereço do arquivo; `null` em texto.
                      transcription_status:
                        type: string
                        description: Situação da transcrição de áudio; `null` em texto.
                      transcription:
                        type: string
                        description: Transcrição de áudio; `null` em texto.
                      log:
                        type: integer
                        description: Tipo de registro automático; `null` em mensagem.
                      user_id:
                        type: string
                        description: ID (UUID) de quem enviou o template.
                        format: uuid
                      frame_id:
                        type: string
                        description: ID (UUID) da conta.
                        format: uuid
                      project_id:
                        type: string
                        description: ID (UUID) do projeto do canal.
                        format: uuid
                      channel_id:
                        type: string
                        description: ID (UUID) do canal por onde o template saiu.
                        format: uuid
                      direction:
                        type: string
                        enum:
                          - outbound
                        description: Sempre `outbound` (saiu da Olie).
                      origin:
                        type: string
                        enum:
                          - internal
                        description: Sempre `internal` (escrito na Olie).
                      external_message_id:
                        type: string
                        description: >-
                          Identificador que o provedor devolveu ao aceitar o
                          template.
                      task_id:
                        type: string
                        description: Sempre `null`.
                      delivery_error:
                        type: string
                        description: >-
                          Sempre `null`: o template só é gravado depois que o
                          provedor o aceita.
                      created_at:
                        type: string
                        description: Data de criação.
                        format: date-time
                      updated_at:
                        type: string
                        description: Data da última alteração.
                        format: date-time
                      deleted_at:
                        type: string
                        description: Data de exclusão; `null` em conteúdo ativo.
                      user:
                        type: object
                        description: Pessoa que enviou o template.
                        properties:
                          id:
                            type: string
                            description: ID (UUID) da pessoa.
                            format: uuid
                          old_id:
                            type: integer
                            description: Identificador legado.
                          name:
                            type: string
                            description: Nome da pessoa.
                          description:
                            type: string
                            description: Descrição do perfil.
                          email:
                            type: string
                            description: E-mail da pessoa.
                          avatar_url:
                            type: string
                            description: Endereço da foto de perfil.
                          status:
                            type: integer
                            description: Situação da conta da pessoa.
                          lang:
                            type: string
                            description: Idioma da pessoa.
                          email_verified_at:
                            type: string
                            description: Data de verificação do e-mail.
                  recorded:
                    type: boolean
                    description: '`true` quando a mensagem foi gravada na conversa.'
              examples:
                Sucesso:
                  value:
                    response: true
                    media:
                      id: 2f3a4b5c-6d7e-4f80-91a2-b3c4d5e6f708
                      name: description.6f1d2c3b4a5e6f708192a3b4c5d6e7f8
                      technical_name: description.6f1d2c3b4a5e6f708192a3b4c5d6e7f8
                      type: 1
                      extension: null
                      text: >-
                        Pedido #1234

                        Olá, Cliente! Seu pedido #1234 foi enviado e chega até
                        20/11.

                        Equipe Exemplo
                      file_url: null
                      transcription_status: null
                      transcription: null
                      log: null
                      user_id: 3e4f5a6b-7c8d-4e9f-a0b1-c2d3e4f5a6b7
                      frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                      project_id: 8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
                      channel_id: 9b2a1c3e-4d5f-6789-abcd-ef0123456789
                      direction: outbound
                      origin: internal
                      external_message_id: wamid.EXEMPLO0123456789
                      task_id: null
                      delivery_error: null
                      created_at: '2026-06-18T15:30:00.000000Z'
                      updated_at: '2026-06-18T15:30:00.000000Z'
                      deleted_at: null
                      user:
                        id: 3e4f5a6b-7c8d-4e9f-a0b1-c2d3e4f5a6b7
                        old_id: null
                        name: Pessoa Exemplo
                        description: null
                        email: pessoa@exemplo.com
                        avatar_url: null
                        status: 1
                        lang: pt_br
                        email_verified_at: '2026-01-10 12:00:00'
                    recorded: true
                Enviado sem gravar na conversa:
                  value:
                    response: true
                    media: null
                    recorded: false
                Sucesso — template nomeado com botão:
                  value:
                    response: true
                    media:
                      id: 2f3a4b5c-6d7e-4f80-91a2-b3c4d5e6f708
                      name: description.6f1d2c3b4a5e6f708192a3b4c5d6e7f8
                      technical_name: description.6f1d2c3b4a5e6f708192a3b4c5d6e7f8
                      type: 1
                      extension: null
                      text: >-
                        Inscrição confirmada

                        Olá, Cliente! Sua inscrição em Evento Exemplo está
                        confirmada para 20/11.

                        Equipe Exemplo
                      file_url: null
                      transcription_status: null
                      transcription: null
                      log: null
                      user_id: 3e4f5a6b-7c8d-4e9f-a0b1-c2d3e4f5a6b7
                      frame_id: 7c0e1d2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f
                      project_id: 8a1f2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
                      channel_id: 9b2a1c3e-4d5f-6789-abcd-ef0123456789
                      direction: outbound
                      origin: internal
                      external_message_id: wamid.EXEMPLO0123456789
                      task_id: null
                      delivery_error: null
                      created_at: '2026-06-18T15:30:00.000000Z'
                      updated_at: '2026-06-18T15:30:00.000000Z'
                      deleted_at: null
                      user:
                        id: 3e4f5a6b-7c8d-4e9f-a0b1-c2d3e4f5a6b7
                        old_id: null
                        name: Pessoa Exemplo
                        description: null
                        email: pessoa@exemplo.com
                        avatar_url: null
                        status: 1
                        lang: pt_br
                        email_verified_at: '2026-01-10 12:00:00'
                    recorded: true
        '404':
          description: Não encontrado
          content:
            application/json:
              schema:
                type: object
                description: Resposta de erro quando o canal não existe nesta conta.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
              example:
                response: false
                message: channel_model_not_found
                error: >-
                  No query results for model [App\Models\Channel]
                  9b2a1c3e-4d5f-6789-abcd-ef0123456789
        '422':
          description: Quantidade de parâmetros diferente da do template
          content:
            application/json:
              schema:
                description: Resposta de erro de validação.
                type: object
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
                  validation:
                    type: object
                    description: >-
                      Mapa de campo para as mensagens de validação daquele
                      campo. Campos possíveis: `name` (ausente, ou template
                      inexistente, não aprovado ou que não pode ser enviado pela
                      Olie), `language`, `parameters.header` e `parameters.body`
                      (formato, ou quantidade diferente da que o template pede),
                      `channel_id` (canal inativo) e `project_id` (projeto do
                      canal excluído ou mesclado).
                    additionalProperties:
                      type: array
                      description: Mensagens de validação do campo.
                      items:
                        type: string
                        description: Mensagem de validação.
              examples:
                Quantidade de parâmetros diferente da do template:
                  value:
                    response: false
                    message: validation_errors
                    error: >-
                      The template expects 3 parameter(s) here (1, 2, 3), 2
                      given.
                    validation:
                      parameters.body:
                        - >-
                          The template expects 3 parameter(s) here (1, 2, 3), 2
                          given.
                Canal inativo:
                  value:
                    response: false
                    message: validation_errors
                    error: >-
                      The selected channel is inactive and cannot receive new
                      messages.
                    validation:
                      channel_id:
                        - >-
                          The selected channel is inactive and cannot receive
                          new messages.
                Canal sem templates:
                  value:
                    response: false
                    message: channel_capability_not_supported
                    error: This channel does not support templates.
                    capability: templates
                Marcador nomeado ou botão faltando:
                  value:
                    response: false
                    message: validation_errors
                    error: >-
                      The template expects exactly these parameters here: nome,
                      evento, data.
                    validation:
                      parameters.body:
                        - >-
                          The template expects exactly these parameters here:
                          nome, evento, data.
                Botão dinâmico sem valor:
                  value:
                    response: false
                    message: validation_errors
                    error: >-
                      The template expects a value for the buttons at positions:
                      0.
                    validation:
                      parameters.buttons:
                        - >-
                          The template expects a value for the buttons at
                          positions: 0.
        '424':
          description: Provedor recusou o envio
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Resposta de erro quando o provedor recusa o template (ou não
                  consegue listá-lo); nada foi enviado nem gravado.
                properties:
                  response:
                    type: boolean
                    description: Sempre `false` em caso de erro.
                  message:
                    type: string
                    description: >-
                      Identificador do erro (slug); é o campo a ser tratado pelo
                      cliente.
                  error:
                    type: string
                    description: Descrição legível do erro.
              example:
                response: false
                message: channel_template_send_failed
                error: The provider did not accept the template.
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.