---
title: "POST /v1/workspaces/{workspaceId}/journeys/{journeyId}/preview"
method: POST
path: "/v1/workspaces/{workspaceId}/journeys/{journeyId}/preview"
---

# POST /v1/workspaces/{workspaceId}/journeys/{journeyId}/preview

`POST /v1/workspaces/{workspaceId}/journeys/{journeyId}/preview`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/journeys/{journeyId}/preview`
- Auth: HTTP bearer

## Response `200`

Journey audience and readiness preview.

- object
  - `data` object, required
    - `sequence_id` string, uuid, required
    - `recipient_count` integer, required
    - `sample_recipients` object[], required
      - `id` string, uuid, required
      - `email` string, required
      - `display_name` string, nullable, required
    - `steps` JourneyStep[], required
      - `id` string, uuid
      - `position` integer
      - `kind` 'email' | 'wait' | 'condition' | 'action' | 'split', required
      - `name` string, required
      - `managed_content` object: Typed source contract and draft/published revision identity for an email step.
        - `id` string, uuid
        - `version` integer
        - `draft_revision_id` string, uuid, nullable
        - `published_revision_id` string, uuid, nullable
        - `published_publication_id` string, uuid, nullable
        - `source_revision_id` string, uuid, nullable
        - `layout_revision_id` string, uuid, nullable
        - `published_layout_revision_id` string, uuid, nullable
        - `source_locale` string, nullable
        - `configured_locales` string[]
        - `variables` object
        - `published_variables` object
      - `config` object, required: Wait steps optionally accept until with name, path, operator (equals, not_equals, contains, or exists), and value, plus required on_met (continue or end_journey). continue skips the following reminder email; end_journey completes the Journey. A reminder email must immediately follow in the same branch. The wait checks current customer data every minute up to amount/unit. Missing fields are unknown and hold the reminder. Ordinary waits and standalone conditions retain their existing behavior. Name checks with verified customer milestones. Managed email steps reference the published content through managed_content_id; activation rejects an unpublished reference. Every email step sets delivery_class: product (transactional email, such as receipts and account mail) or broadcast (marketing, which carries an unsubscribe link and needs the product Brand's company name and mailing address); a step without it is refused with 400 journey_delivery_class_required. Email steps may set expires_after_seconds (1-604800) to discard a deferred send after that interval from its original start; the default is seven days.
      - `arms` JourneyArm[]
        - `key` 'A' | 'B' | 'C' | 'D', required
        - `label` string, required
        - `allocation` number, required
        - `steps` JourneyStep[], required
    - `ready` boolean, required
    - `exit_config` JourneyExit, required
      - `on_reply` boolean
      - `on_unsubscribe` boolean
      - `on_suppression` boolean
      - `event` string
    - `emails` object[], required
      - `step_id` string, uuid, nullable, required
      - `name` string, required
      - `arm` object
        - `split_step_id` string, uuid
        - `key` string, required
        - `label` string, required
      - `source` 'managed' | 'design' | 'inline' | 'empty', required
      - `template_id` string, uuid
      - `managed_content_id` string, uuid
      - `subject` string, required
      - `preview` string, required
      - `blockers` object[], required
        - `code` string, required
        - `message` string, required
    - `blockers` object[], required
      - `code` string, required
      - `message` string, required
      - `step_id` string, uuid, nullable, required
      - `step_name` string, required
      - `arm` string

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)