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

# Preview de execução da campanha

> Estimativa de audiência, overlap, custo e avisos antes do Run. Escopo: `campaigns:read`.



## OpenAPI

````yaml /es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/run-preview
openapi: 3.0.3
info:
  title: Notifique API Contatos, tags e audiência
  description: >-
    API para **CRUD de contatos**, **tags**, **tópicos**, **segmentos** e
    **campanhas** (template + audiência + canais).


    **Contato:** pelo menos um de **phone** ou **email** (únicos por workspace).
    **Idiomas:** `languages` é um array de códigos BCP-47 permitidos (lista em
    **`GET /v1/meta/contact-locales`**); ordem = prioridade. **Telegram:** use
    **`telegramLinks`** (`instanceId` + `peer`) para várias instâncias Telegram
    no mesmo workspace; **Use `telegramLinks` (`instanceId` + `peer`) para
    Telegram. Na campanha, o peer usado é o da **`telegramInstanceId`** da
    campanha (ou default), com *fallback* para Use `telegramLinks` (`instanceId`
    + `peer`) para Telegram.


    **Campanhas:** `channels` pode incluir `whatsapp`, `sms`, `email`,
    `telegram`. Cada canal listado deve estar **habilitado no template**.
    **`instanceId`** = WhatsApp; **`telegramInstanceId`** = Telegram.
    **`channelFailureMode`:** `STRICT` (padrão) aborta o Run se um canal falhar
    na infra; `PARTIAL` ignora aquele canal e segue nos demais (


    **WhatsApp cartão:** `POST /v1/whatsapp/messages` com `type: "contact"` e
    `payload.contactId`.


    **Autenticação:** `Authorization: Bearer sk_live_xxxxx` ou `x-api-key`.


    **Escopos:** `contacts:*`, `tags:*`, `topics:*`, `segments:*`, `campaigns:*`
    (inclui `campaigns:run`).


    **Campanhas (extras):** `POST .../cancel` (DRAFT/SCHEDULED), `GET .../stats`
    e `GET .../recipients` (escopos update/read). Run devolve `runId`. Sending
    Pool WhatsApp: painel.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfContactBearerAuth: []
  - ntfContactApiKeyHeader: []
tags:
  - name: Contatos
    description: CRUD de contatos do workspace (phone ou email; tags)
  - name: Tags
    description: Tags (rótulos) para vincular a contatos
  - name: Tópicos
    description: Tópicos de comunicação (marketing / opt-in por tema)
  - name: Segmentos
    description: >-
      Segmentos de audiencia (DSL v1). Regras: tag, property, contactField,
      topic, receiveMarketing. Escopos segments:read|create|update|delete.
  - name: Campanhas
    description: Campanhas multicanal com template; execução via POST .../run
  - name: Pipelines
    description: CRM pipelines (boards, cards)
  - name: Contactos
  - name: Meta
    description: Metadatos y catálogos auxiliares de la API v1.
  - name: Tareas
    description: Tareas CRM del workspace.
paths:
  /v1/campaigns/{campaignId}/run-preview:
    get:
      tags:
        - Campanhas
      summary: Preview de execução da campanha
      description: >-
        Estimativa de audiência, overlap, custo e avisos antes do Run. Escopo:
        `campaigns:read`.
      operationId: ntfContact_getV1CampaignRunPreview
      parameters:
        - name: campaignId
          in: path
          required: true
          schema:
            type: string
        - name: channels
          in: query
          required: false
          schema:
            type: string
          description: 'CSV opcional: whatsapp,sms,email,telegram,push,rcs,instagram'
        - name: excludeAlreadySent
          in: query
          required: false
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: Preview em `data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_CampaignRunPreviewResponse'
              example:
                success: true
                data:
                  audienceCount: 1
                  uniqueRecipients: 1
                  lastRun: {}
                  channels:
                    - string
                  newInAudience: 1
                  totalEstimatedCredits: 1
                  warnings:
                    - string
        '401':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '403':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
        '404':
          description: Erro
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfContact_ErrorResponse'
              example:
                success: false
                error: Bad Request
                code: VALIDATION_ERROR
                message: Campo inválido ou ausente.
components:
  schemas:
    NtfContact_CampaignRunPreviewResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            audienceCount:
              type: integer
            uniqueRecipients:
              type: integer
            lastRun:
              type: object
              nullable: true
              properties: {}
            channels:
              type: array
              items:
                type: string
            newInAudience:
              type: integer
            totalEstimatedCredits:
              type: integer
            warnings:
              type: array
              items:
                type: string
      example:
        success: true
        data:
          audienceCount: 1
          uniqueRecipients: 1
          lastRun: {}
          channels:
            - string
          newInAudience: 1
          totalEstimatedCredits: 1
          warnings:
            - string
    NtfContact_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
      example:
        success: false
        error: string
        message: string
        code: string
  securitySchemes:
    ntfContactBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Authorization: Bearer sk_live_xxxxx'
    ntfContactApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'x-api-key: sk_live_xxxxx'

````