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

# Enviar lista de opções

> Envia uma lista interativa com seções e opções selecionáveis.

Envia uma lista interativa com seções e opções selecionáveis.


## OpenAPI

````yaml POST /instances/{instanceId}/token/{instanceToken}/send-option-list
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/send-option-list:
    post:
      tags:
        - Mensagens
      summary: Enviar lista de opções
      description: Envia uma lista interativa com seções e opções selecionáveis.
      operationId: messages_send-option-list
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                phone:
                  type: string
                  example: '{{PHONE}}'
                  description: >-
                    Número com código do país (ex: 554499999999) ou JID de grupo
                    (ex: 120363123456789@g.us)
                message:
                  type: string
                  example: 'Selecione e melhor opção:'
                optionList:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Opções disponíveis
                    buttonLabel:
                      type: string
                      example: Abrir lista de opções
                    options:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            example: '1'
                          description:
                            type: string
                            example: WA Gateway Asas para sua imaginação
                          title:
                            type: string
                            example: WA Gateway
                        required:
                          - id
                          - description
                          - title
                        example:
                          id: '1'
                          description: WA Gateway Asas para sua imaginação
                          title: WA Gateway
                      example:
                        - id: '1'
                          description: WA Gateway Asas para sua imaginação
                          title: WA Gateway
                        - id: '2'
                          description: Não funcionam
                          title: Outros
                  required:
                    - title
                    - buttonLabel
                    - options
                  example:
                    title: Opções disponíveis
                    buttonLabel: Abrir lista de opções
                    options:
                      - id: '1'
                        description: WA Gateway Asas para sua imaginação
                        title: WA Gateway
                      - id: '2'
                        description: Não funcionam
                        title: Outros
                mentioned:
                  type: array
                  items:
                    type: string
                  description: Lista de números para mencionar em grupos
                  example:
                    - '554499999999'
                mentionsEveryOne:
                  type: boolean
                  description: Mencionar todos os participantes do grupo
                  default: false
              required:
                - phone
                - message
                - optionList
              example:
                phone: '{{PHONE}}'
                message: 'Selecione e melhor opção:'
                optionList:
                  title: Opções disponíveis
                  buttonLabel: Abrir lista de opções
                  options:
                    - id: '1'
                      description: WA Gateway Asas para sua imaginação
                      title: WA Gateway
                    - id: '2'
                      description: Não funcionam
                      title: Outros
            examples:
              enviar-lista-de-opcoes:
                summary: Enviar lista de opções
                value:
                  phone: '{{PHONE}}'
                  message: 'Selecione e melhor opção:'
                  optionList:
                    title: Opções disponíveis
                    buttonLabel: Abrir lista de opções
                    options:
                      - id: '1'
                        description: WA Gateway Asas para sua imaginação
                        title: WA Gateway
                      - id: '2'
                        description: Não funcionam
                        title: Outros
              enviar-em-grupo:
                summary: Enviar lista de opções em grupo
                value:
                  phone: 120363123456789@g.us
                  message: 'Selecione uma opção:'
                  optionList:
                    title: Opções
                    buttonLabel: Ver opções
                    options:
                      - id: '1'
                        description: Descrição
                        title: Opção 1
                  mentioned:
                    - '554499999999'
      responses:
        '202':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  messageId:
                    type: string
                    example: 3EB047ED70306656281B34
                  id:
                    type: string
                    example: 3EB047ED70306656281B34
                required:
                  - messageId
                  - id
                example:
                  messageId: 3EB047ED70306656281B34
                  id: 3EB047ED70306656281B34
              example:
                messageId: 3EB047ED70306656281B34
                id: 3EB047ED70306656281B34
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
        '408':
          description: Timeout do worker
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Worker command timeout
        '422':
          description: Falha ao processar a ação
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unable to process request
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````