> ## 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.

# Simular el mensaje de la campaña

> Resuelve las variables de la plantilla a partir de una fila de lista (`list_id` + `row_id`) o de un contacto (`contact_id`) y devuelve el mensaje formateado. No se envía nada.



## OpenAPI

````yaml /es/openapi.json post /v1/campaigns/preview-message
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentación de la API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensajes
  - name: contacts
    x-group: Contactos
  - name: campaigns
    x-group: Campañas
  - name: tables
    x-group: Tablas y listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversaciones
  - name: inboxes
    x-group: Inboxes
  - name: knowledge
    x-group: Base de conocimiento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscripciones en Campaña
  - name: custom-fields
    x-group: Campos personalizados
  - name: resources
    x-group: Archivos y adjuntos
  - name: hubspot
    x-group: HubSpot
  - name: users
    x-group: Usuarios
paths:
  /v1/campaigns/preview-message:
    post:
      tags:
        - campaigns
      summary: Simular el mensaje de la campaña
      description: >-
        Resuelve las variables de la plantilla a partir de una fila de lista
        (`list_id` + `row_id`) o de un contacto (`contact_id`) y devuelve el
        mensaje formateado. No se envía nada.
      operationId: CampaignController_previewMessage
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador de la empresa objetivo. Obligatorio solo para API keys
            globales (type=global). Se ignora para API keys de empresa y
            usuarios humanos.
          required: false
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewMessageDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      security:
        - JWT-auth: []
components:
  schemas:
    PreviewMessageDto:
      type: object
      properties:
        action_config:
          type: object
          properties:
            text_content:
              type: string
            template_name:
              type: string
            language_code:
              default: pt_BR
              type: string
            components:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - header
                      - body
                      - button
                    description: Tipo del componente (header, body, button)
                  sub_type:
                    description: >-
                      Subtipo del componente (se usa principalmente para
                      botones)
                    type: string
                    enum:
                      - quick_reply
                      - url
                      - phone_number
                  index:
                    description: >-
                      Índice del componente (se usa para identificar botones
                      específicos)
                    anyOf:
                      - type: string
                      - type: number
                  parameters:
                    description: Lista de parámetros/variables de este componente
                    type: array
                    items:
                      type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - text
                            - image
                            - document
                            - video
                            - currency
                            - date_time
                            - payload
                          description: Tipo del parámetro
                        image:
                          description: Configuración de imagen (cuando type = "image")
                          type: object
                          properties:
                            link:
                              description: URL de la imagen
                              type: string
                            id:
                              description: ID de la imagen ya cargada
                              type: string
                        document:
                          description: >-
                            Configuración de documento (cuando type =
                            "document")
                          type: object
                          properties:
                            link:
                              description: URL del documento
                              type: string
                            filename:
                              description: Nombre del archivo del documento
                              type: string
                        video:
                          description: Configuración de video (cuando type = "video")
                          type: object
                          properties:
                            link:
                              description: URL del video
                              type: string
                        text:
                          description: Texto del parámetro
                          type: string
                        value:
                          description: Valor genérico del parámetro (alias de text)
                          type: string
                        link:
                          description: Enlace genérico
                          type: string
                        imageUrl:
                          description: URL alternativa para la imagen
                          type: string
                        imageId:
                          description: ID de la imagen (cuando ya se cargó)
                          type: string
                        documentUrl:
                          description: URL alternativa para el documento
                          type: string
                        documentFilename:
                          description: Nombre alternativo del archivo
                          type: string
                        videoUrl:
                          description: URL alternativa para el video
                          type: string
                        currencyCode:
                          description: 'Código de la moneda (ej.: BRL, USD, EUR)'
                          type: string
                        currencyAmount:
                          description: Valor monetario
                          type: number
                        dateTime:
                          description: Fecha/hora en formato ISO 8601
                          type: string
                        payload:
                          description: Datos personalizados en formato string
                          type: string
                        parameter_name:
                          description: Nombre del parámetro (para plantillas con nombre)
                          type: string
                        variable_ref:
                          description: >-
                            Referencia a una variable automática (ej.:
                            V_contact_name). Si está presente, el valor se
                            resuelve automáticamente a partir del
                            contacto/business/conversación.
                          type: string
                        variable_type:
                          description: >-
                            Tipo de la variable: "auto" = se resuelve
                            automáticamente, "free" = entrada manual
                          type: string
                          enum:
                            - auto
                            - free
                      required:
                        - type
                required:
                  - type
        list_id:
          type: string
        row_id:
          type: string
        contact_id:
          type: string
        variables:
          type: object
          additionalProperties: {}
        inbox_id:
          type: string
      required:
        - action_config
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticación

````

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