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

# Create a journey

> Creates a draft journey with a name, an event trigger and, optionally, a full graph of
`nodes` and `edges`. Omit both `nodes` and `edges` to start from a graph of one `enter`
node connected to one `exit` node. When submitting `nodes`, each node carries a `temporary_id`
that edges refer to. The response returns each `temporary_id` beside the node's new `id`.
Use the `id` when using the node deletion endpoint. Messaging nodes (`email`, `sms` or `push`)
need a provider for that channel in your project. Once created you can add content to a message node
using the "Journey Message Contents" endpoints. Nothing is created if the request is rejected. Returns
the journey in the same shape as `GET /journeys/{id}`.


> [!WARNING]
>
> This endpoint is in alpha and is subject to change at any time. Email support for access.


## OpenAPI

````yaml /api-reference/campaigns-v2/campaigns-v2.yaml post /journeys
openapi: 3.0.3
info:
  title: Vero Open API v2
  version: 2.0.0
  description: >-
    API for interfacing with Vero to design, update and manage broadcasts,
    journeys, and topics.
servers:
  - url: https://api.getvero.com/api/v2
security:
  - ApiKeyAuth: []
tags:
  - name: Broadcasts
  - name: Broadcast Messages
  - name: Broadcast Message Contents
  - name: Journeys
  - name: Journey Nodes
  - name: Journey Messages
  - name: Journey Message Contents
  - name: Campaigns
  - name: Campaign Messages
  - name: Campaign Message Contents
  - name: Topics
paths:
  /journeys:
    post:
      tags:
        - Journeys
      summary: Create a journey
      description: >
        Creates a draft journey with a name, an event trigger and, optionally, a
        full graph of

        `nodes` and `edges`. Omit both `nodes` and `edges` to start from a graph
        of one `enter`

        node connected to one `exit` node. When submitting `nodes`, each node
        carries a `temporary_id`

        that edges refer to. The response returns each `temporary_id` beside the
        node's new `id`.

        Use the `id` when using the node deletion endpoint. Messaging nodes
        (`email`, `sms` or `push`)

        need a provider for that channel in your project. Once created you can
        add content to a message node

        using the "Journey Message Contents" endpoints. Nothing is created if
        the request is rejected. Returns

        the journey in the same shape as `GET /journeys/{id}`.
      operationId: createJourney
      parameters:
        - name: revision
          in: header
          required: false
          description: >-
            Optional dated API revision for the request. Must use `YYYY-MM-DD`
            format.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
            example: '2026-03-01'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJourneyRequest'
            examples:
              name_and_trigger:
                summary: Name and trigger only
                value:
                  name: Welcome series
                  trigger:
                    type: event
                    event_name: signed_up
              with_graph:
                summary: With a graph
                value:
                  name: Welcome series
                  trigger:
                    type: event
                    event_name: signed_up
                  nodes:
                    - temporary_id: start
                      type: enter
                    - temporary_id: wait
                      type: delay
                      delay:
                        delivery_option: 1
                        duration: 1
                        duration_unit: days
                    - temporary_id: welcome
                      type: email
                      title: Welcome email
                    - temporary_id: done
                      type: exit
                  edges:
                    - from: start
                      to: wait
                    - from: wait
                      to: welcome
                    - from: welcome
                      to: done
        required: true
      responses:
        '201':
          description: Journey created.
          content:
            application/json:
              examples:
                default:
                  value:
                    id: 42
                    name: Welcome series
                    description: null
                    status: draft
                    trigger:
                      type: event
                      event_name: signed_up
                    nodes:
                      - id: 1
                        temporary_id: start
                        type: enter
                      - id: 2
                        temporary_id: wait
                        type: delay
                        delay:
                          delivery_option: 1
                          duration: 1
                          duration_unit: days
                          delay_property: null
                          property_type: null
                          preferred_delivery_time: null
                      - id: 3
                        temporary_id: welcome
                        type: email
                        title: Welcome email
                        message:
                          id: 100
                          from: null
                          reply_to: null
                          contents:
                            - id: 200
                              locale: null
                              is_default: true
                              subject: null
                              preheader_text: null
                      - id: 4
                        temporary_id: done
                        type: exit
                    edges:
                      - from: 1
                        to: 2
                      - from: 2
                        to: 3
                      - from: 3
                        to: 4
                    created_at: '2026-03-01T10:00:00Z'
                    updated_at: '2026-03-01T10:00:00Z'
              schema:
                $ref: '#/components/schemas/Journey'
        '422':
          description: >-
            Invalid request body, an invalid graph, or a referenced event,
            segment or provider was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CreateJourneyRequest:
      type: object
      description: >
        Create a draft journey. Send `nodes` and `edges` together to build the
        graph, or omit both

        to start from a graph of one `enter` node connected to one `exit` node.
      required:
        - name
        - trigger
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Journey name. Trimmed before validation; must be non-blank.
        trigger:
          type: object
          description: The event that enters people into the journey.
          required:
            - type
            - event_name
          properties:
            type:
              type: string
              enum:
                - event
            event_name:
              type: string
              minLength: 1
              description: >
                The API name of an existing event in your project. Trimmed
                before validation.

                Reserved system events cannot be used as a trigger.
          additionalProperties: false
        nodes:
          type: array
          maxItems: 1000
          description: >
            The journey's nodes. A graph needs exactly one `enter` node, which
            has no incoming

            edges, and at least one `exit` node. Every node must be reachable
            from the `enter`

            node, and the graph must not contain cycles. Each `branch` and
            `random_split` arm

            must end in an `exit` or rejoin the other arm at the first node both
            arms reach.

            A `random_split` arm cannot contain a `branch`, an `exit`, or
            another `random_split`.
          items:
            type: object
            required:
              - temporary_id
              - type
            properties:
              temporary_id:
                type: string
                pattern: ^[A-Za-z][A-Za-z0-9_-]{0,63}$
                description: >
                  Identifies the node within this request, so edges can refer to
                  it. Must be

                  unique in the request, start with a letter, and contain only
                  letters, numbers,

                  underscores and hyphens. Not stored: the `201` response
                  returns it beside the

                  node's new `id`.
              type:
                type: string
                enum:
                  - enter
                  - exit
                  - email
                  - sms
                  - push
                  - delay
                  - branch
                  - random_split
                  - filter
              title:
                type: string
                minLength: 1
                maxLength: 255
                description: >
                  `email`, `sms` and `push` nodes only. The message title.
                  Defaults to the

                  node type's title in the Vero UI.
              delay:
                type: object
                description: >
                  `delay` nodes only. The delay settings, in the same shape `GET
                  /journeys/{id}`

                  returns. Omit for a fixed 30 minute wait.
              conditions:
                type: object
                description: >
                  `branch` and `filter` nodes only. The conditions people are
                  matched against, in

                  the same shape `GET /journeys/{id}` returns.
              scope:
                type: string
                nullable: true
                maxLength: 255
                description: >
                  `branch` and `filter` nodes only. A trigger event property
                  name that scopes

                  event property conditions, as on `GET /journeys/{id}`.
            additionalProperties: false
        edges:
          type: array
          maxItems: 2000
          description: >
            The journey's edges. A `branch` or `random_split` node has exactly
            two outgoing edges,

            with `branch_index` `0` and `1`. An `exit` node has none, and every
            other node has

            exactly one.
          items:
            type: object
            required:
              - from
              - to
            properties:
              from:
                type: string
                description: Source node `temporary_id`.
              to:
                type: string
                description: Target node `temporary_id`.
              branch_index:
                type: integer
                nullable: true
                minimum: 0
                maximum: 1
                description: >
                  Required on edges leaving a `branch` or `random_split` node,
                  identifying the arm.

                  Omit (or send `null`) on every other edge.
            additionalProperties: false
      additionalProperties: false
    Journey:
      type: object
      description: >-
        A journey with its full graph — its `trigger`, `nodes` and `edges`.
        Messaging nodes expose message and content metadata but not content
        bodies or audience details.
      required:
        - id
        - name
        - description
        - status
        - trigger
        - nodes
        - edges
        - created_at
        - updated_at
      properties:
        id:
          type: integer
        name:
          type: string
          description: Journey name.
        description:
          type: string
          nullable: true
          description: Optional journey description. May be `null`.
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - archived
            - cancelled
          description: Journey lifecycle status.
        trigger:
          type: object
          nullable: true
          description: >-
            The event that enters people into the journey. `null` when none is
            set.
          required:
            - type
            - event_name
          properties:
            type:
              type: string
              enum:
                - event
            event_name:
              type: string
              description: The API name of the triggering event.
        nodes:
          type: array
          items:
            type: object
            required:
              - id
              - type
            properties:
              id:
                type: integer
              type:
                type: string
                enum:
                  - enter
                  - exit
                  - email
                  - push
                  - sms
                  - delay
                  - branch
                  - random_split
                  - filter
                  - ab_test
                  - ab_test_end
              temporary_id:
                type: string
                description: >-
                  Only in the `201` response of `POST /journeys`, echoing the
                  `temporary_id` the node was created with. Not stored, and not
                  returned by any other endpoint.
              title:
                type: string
                nullable: true
                description: On messaging nodes, the message's title.
              delay:
                type: object
                nullable: true
                description: On `delay` nodes, the delay settings.
              conditions:
                type: object
                nullable: true
                description: >-
                  On `branch` and `filter` nodes, the conditions people are
                  matched against.
              scope:
                type: string
                nullable: true
                description: >-
                  On `branch` and `filter` nodes, a trigger event property name
                  (shown in the Vero UI as `event.<scope>`). When set,
                  conditions that reference event properties only match when
                  they share the trigger event's value for this property. Null
                  when the conditions are unscoped.
              message:
                type: object
                nullable: true
                description: On messaging nodes, the message's sender and content metadata.
                required:
                  - id
                  - from
                  - reply_to
                  - contents
                properties:
                  id:
                    type: integer
                  from:
                    type: string
                    nullable: true
                  reply_to:
                    type: string
                    nullable: true
                  contents:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - locale
                        - is_default
                        - subject
                        - preheader_text
                      properties:
                        id:
                          type: integer
                        locale:
                          type: string
                          nullable: true
                        is_default:
                          type: boolean
                        subject:
                          type: string
                          nullable: true
                        preheader_text:
                          type: string
                          nullable: true
        edges:
          type: array
          items:
            type: object
            required:
              - from
              - to
            properties:
              from:
                type: integer
                description: Source node `id`.
              to:
                type: integer
                description: Target node `id`.
              branch_index:
                type: integer
                description: >-
                  Present only on edges leaving a `branch`, `random_split`, or
                  `ab_test` node, identifying the arm the edge belongs to. A
                  `branch` node's arms are `0` and `1`. A `random_split` created
                  through this API has arms `0` and `1`.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ErrorList:
      type: object
      required:
        - errors
      properties:
        errors:
          type: array
          items:
            type: object
            required:
              - message
            properties:
              message:
                type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Accepts either a raw API key or `Bearer <key>`.

````

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