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

# Listar quem fica de fora da campanha

> Pessoas da audiência que não recebem a campanha, com o motivo. Nenhuma inscrição é criada. Recebe o mesmo corpo da prévia de audiência, mais paginação, busca por nome e filtro por motivo.



## OpenAPI

````yaml https://api.nuvia.ai/api/docs/user-json post /v1/campaigns/audience-preview/excluded
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentação da API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
  - name: resources
    x-group: Arquivos e Anexos
  - name: hubspot
    x-group: HubSpot
paths:
  /v1/campaigns/audience-preview/excluded:
    post:
      tags:
        - campaigns
      summary: Listar quem fica de fora da campanha
      description: >-
        Pessoas da audiência que não recebem a campanha, com o motivo. Nenhuma
        inscrição é criada. Recebe o mesmo corpo da prévia de audiência, mais
        paginação, busca por nome e filtro por motivo.
      operationId: CampaignController_audiencePreviewExcluded
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador da empresa-alvo. Obrigatório apenas para API Keys
            globais (type=global). Ignorado para API Keys de empresa e usuários
            humanos.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AudiencePreviewExcludedBodyDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
        - JWT-auth: []
components:
  schemas:
    AudiencePreviewExcludedBodyDto:
      type: object
      properties:
        channel_type:
          type: string
          description: Canal de disparo da campanha. Define a validação por canal.
          enum:
            - WAP_AUTO_CLOSER
            - WEB_V2
            - EVOLUTION_API
            - LINKEDIN
            - MULTI_CHANNEL
        audience_config:
          type: object
          description: Audiência simulada, no mesmo formato da criação da campanha.
          properties:
            type:
              description: Tipo de audiência.
              type: string
              enum:
                - STATIC
                - DYNAMIC
                - EXTERNAL
                - LIST
                - FUNNEL
            contact_ids:
              description: IDs dos contatos, para audiência `STATIC`.
              type: array
              items:
                type: string
            lists:
              description: Listas de contatos, para audiência `LIST`.
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    description: ID da lista.
                  views:
                    description: >-
                      IDs de visões da lista. Hoje não restringem nada: a lista
                      inteira é considerada.
                    type: array
                    items:
                      type: string
                required:
                  - id
            funnel_config:
              description: Funil (agente) e, opcionalmente, etapa, para audiência `FUNNEL`.
              type: object
              properties:
                agent_id:
                  type: string
                  minLength: 1
                agent_step_id:
                  type: string
              required:
                - agent_id
            match_criteria:
              description: Filtros por campo aplicados à audiência.
              type: object
              properties:
                match_logic:
                  default: AND
                  description: Lógica de combinação entre grupos
                  type: string
                  enum:
                    - AND
                    - OR
                filter_groups:
                  minItems: 1
                  type: array
                  items:
                    type: object
                    properties:
                      logic:
                        type: string
                        enum:
                          - AND
                          - OR
                        description: Lógica de combinação das condições
                      conditions:
                        minItems: 1
                        type: array
                        items:
                          anyOf:
                            - type: object
                              properties:
                                field_id:
                                  type: string
                                  minLength: 1
                                  description: >-
                                    ID do campo personalizado ou path fixo (ex:
                                    contact.name, contact.email)
                                operator:
                                  type: string
                                  enum:
                                    - eq
                                    - neq
                                    - gt
                                    - gte
                                    - lt
                                    - lte
                                    - contains
                                    - not_contains
                                    - starts_with
                                    - ends_with
                                    - is_empty
                                    - is_not_empty
                                    - in
                                    - not_in
                                  description: Operador de comparação
                                value:
                                  description: Valor para comparação
                                  anyOf:
                                    - type: string
                                      nullable: true
                                    - type: number
                                      nullable: true
                                    - type: boolean
                                      nullable: true
                                    - type: array
                                      items:
                                        type: string
                                      nullable: true
                              required:
                                - field_id
                                - operator
                            - type: object
                    required:
                      - logic
                      - conditions
              required:
                - filter_groups
        behavior_config:
          type: object
          description: Regra de conversa aberta, como está configurada na tela.
          properties:
            skip_if_active_conversation:
              description: >-
                Se true, quem já tem conversa aberta fica de fora (regra "Já tem
                conversa aberta").
              type: boolean
            active_conversation_window_minutes:
              description: Janela, em minutos, que define conversa aberta.
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
        exclusion_lists:
          type: array
          description: >-
            Listas de exclusão, na ordem em que foram adicionadas. Quem está
            nelas fica de fora.
          items:
            type: object
            properties:
              id:
                type: string
                description: ID da lista de exclusão.
            required:
              - id
        page:
          type: integer
          description: Página. Padrão 1.
          minimum: -9007199254740991
          maximum: 9007199254740991
        limit:
          type: integer
          description: Itens por página. Padrão 20, no máximo 100.
          minimum: -9007199254740991
          maximum: 9007199254740991
        search:
          type: string
          description: Busca pelo nome do contato.
        reason:
          type: string
          description: Filtra pelo motivo de ficar de fora. Padrão `all`.
          enum:
            - all
            - filtered_out
            - active_conversation
            - exclusion_list
            - no_active_channel
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````

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