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

# Render a campaign preview

> Renders the campaign’s primary template against representative variables and returns the channel-specific preview output.



## OpenAPI

````yaml https://apix.spotzee.com/api/openapi.json get /campaigns/{campaignId}/preview
openapi: 3.1.0
info:
  title: Spotzee API
  version: '2026-04-28'
  description: >-
    Programmatic access to Spotzee. Use this API to manage users, lists,
    segments, campaigns, journeys, templates, and events from your own systems.
  contact:
    name: Spotzee Support
    url: https://docs.spotzee.com
  license:
    name: Proprietary
    url: https://docs.spotzee.com/
servers:
  - url: https://apix.spotzee.com/api
    description: >-
      Public unauthenticated surface — used for form-token submissions and other
      token-scoped callbacks.
  - url: https://apix.spotzee.com/api/client
    description: >-
      Project-scoped surface — use with `sk_` (secret) or `pk_` (publishable)
      API keys.
  - url: https://apix.spotzee.com/api/admin
    description: >-
      Organisation-scoped surface — use with `ok_` API keys for cross-project
      administration.
security: []
tags:
  - name: Projects
    description: >-
      The project the calling key belongs to. Read-only on the project surface —
      use organisation-level keys for project lifecycle.
  - name: Users
    description: >-
      People you message. Identify each one by your own `external_id`; attach
      any custom attributes you want to segment on.
  - name: Events
    description: >-
      Behavioural signals from your application. Drive trigger campaigns and
      journeys, enrich segments, and personalise message content.
  - name: Form submissions
    description: >-
      Token-scoped website form submissions. Use generated form URLs for
      browser-safe opt-ins without exposing secret API keys.
  - name: Lists
    description: >-
      Static and dynamic groups of users. Static lists are explicit memberships;
      dynamic lists evaluate their current membership rule when queried.
  - name: Subscriptions
    description: >-
      Channel-level opt-in state per user. Each subscription type maps to a
      channel (email, push, SMS, webhook, in-app).
  - name: Templates
    description: >-
      Channel-specific message bodies with Handlebars personalisation. Preview,
      proof, and version each template independently.
  - name: Campaigns
    description: >-
      One-off `blast` sends and per-user `trigger` sends. Each campaign targets
      one channel and one subscription type.
  - name: CRM
    description: >-
      Customer relationship records for contacts, companies, pipeline stages,
      activities, and saved views within the calling project.
  - name: Source Sync
    description: >-
      Sync contacts, companies, source-managed CRM properties, and company
      memberships from your own backend systems into the calling project.
  - name: Journeys
    description: >-
      Multi-step automation flows triggered by events, list memberships, or
      campaign sends. Branch on attributes, wait between steps, and send across
      channels.
  - name: Tags
    description: >-
      Free-form labels you can attach to campaigns, journeys, lists, and
      templates for organisation and bulk filtering.
  - name: API keys
    description: >-
      Project-scoped credentials. Create, list, and revoke `sk_` and `pk_` keys
      for the project the calling key belongs to.
  - name: Organisation
    description: >-
      Organisation-scoped operations. Use with `ok_` keys to manage projects
      across an organisation, including the org-level API key catalogue.
  - name: Webhooks
    description: >-
      Outgoing event delivery. Configure HTTPS endpoints, choose events, and
      verify inbound deliveries with the `Spotzee-Signature` HMAC header.
paths:
  /campaigns/{campaignId}/preview:
    get:
      tags:
        - Campaigns
      summary: Render a campaign preview
      description: >-
        Renders the campaign’s primary template against representative variables
        and returns the channel-specific preview output.
      operationId: previewCampaign
      parameters:
        - schema:
            type: integer
            exclusiveMinimum: 0
            description: Numeric campaign identifier.
            example: 24
          required: true
          description: Numeric campaign identifier.
          name: campaignId
          in: path
      responses:
        '200':
          description: Channel-specific preview output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignPreviewResponse'
        '400':
          description: Malformed request — bad parameters, body, or version header.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required or the supplied API key is invalid.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Authenticated, but the credential lacks scope or role for this
            resource.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            The referenced resource does not exist or is not visible to this
            key.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — duplicate resource or idempotency-key body mismatch.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Request was syntactically valid but semantically rejected (failed
            validation).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate-limit bucket exhausted. Honour `Retry-After`.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Unhandled server error. `request_id` should be reported to support.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - projectApiKey: []
      servers:
        - url: https://apix.spotzee.com/api/client
components:
  schemas:
    CampaignPreviewResponse:
      type: object
      additionalProperties: true
      description: Channel-specific preview output for the campaign’s primary template.
    ErrorResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - error
          description: Constant marker indicating this payload is an error response.
        code:
          $ref: '#/components/schemas/ErrorCode'
        title:
          type: string
          description: Short, human-readable summary suitable for a heading. en-AU.
          example: Resource missing
        message:
          type: string
          description: Human-readable, en-AU explanation. May include identifiers.
          example: User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.
        error:
          type: string
          description: >-
            Legacy human-readable mirror of `message`. Retained while in-product
            clients migrate; new integrations should read `message`.
        type:
          type: string
          format: uri
          description: Documentation URL for this error class (RFC 7807).
          example: https://docs.spotzee.com/main-api/errors#resource_missing
        request_id:
          type: string
          description: >-
            Server-generated correlation ID. Echoed in the X-Request-ID response
            header.
          example: req_01HXY7Z9K8M5J2N4P6Q8R0S1T2
        param:
          type: string
          description: Name of the offending parameter, when a single field is at fault.
          example: id
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: Field-level errors when multiple parameters fail validation.
      required:
        - status
        - code
        - message
        - error
      description: >-
        Spotzee error envelope (RFC 7807 + Stripe-style extensions). Served as
        `application/problem+json`.
    ErrorCode:
      type: string
      enum:
        - resource_missing
        - resource_already_exists
        - state_conflict
        - archived_user_conflict
        - user_capacity_exhausted
        - parameter_missing
        - parameter_invalid_empty
        - parameter_invalid_format
        - parameter_unknown
        - validation_failed
        - authentication_required
        - permission_denied
        - idempotency_key_mismatch
        - idempotency_key_invalid
        - idempotency_in_progress
        - rate_limited
        - version_unsupported
        - version_required
        - webhook_signature_invalid
        - quota_exceeded
        - service_unavailable
        - internal_error
      description: Stable, machine-readable error code. Safe to switch on; never localised.
      example: resource_missing
    FieldError:
      type: object
      properties:
        param:
          type: string
          description: Dotted path to the offending request field.
          example: email
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCode'
            - description: Per-field error code.
              example: parameter_invalid_format
        message:
          type: string
          description: Human-readable, English (en-AU) explanation of this field error.
          example: Must be a valid email address.
      required:
        - param
        - code
        - message
  securitySchemes:
    projectApiKey:
      type: http
      scheme: bearer
      description: >-
        Project-scoped secret API key (`sk_…`). Pass in the `Authorization:
        Bearer <key>` header. Grants access to the project the key was issued
        for.

````

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