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

# Update a journey

> Renames a journey and/or changes the event that triggers it. Omitted fields are left unchanged.
Draft, active and paused journeys can be updated; archived journeys, journeys that are locked
for editing, and journeys built with the legacy (Vero 1.0) journey builder return `409`. A
journey's steps (`nodes` and `edges`) cannot be changed through this endpoint. Returns the
updated journey in the same shape as `GET /journeys/{id}`.


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


## OpenAPI

````yaml /api-reference/campaigns-v2/campaigns-v2.yaml patch /journeys/{id}
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 Messages
  - name: Journey Message Contents
  - name: Campaigns
  - name: Campaign Messages
  - name: Campaign Message Contents
  - name: Topics
paths:
  /journeys/{id}:
    patch:
      tags:
        - Journeys
      summary: Update a journey
      description: >
        Renames a journey and/or changes the event that triggers it. Omitted
        fields are left unchanged.

        Draft, active and paused journeys can be updated; archived journeys,
        journeys that are locked

        for editing, and journeys built with the legacy (Vero 1.0) journey
        builder return `409`. A

        journey's steps (`nodes` and `edges`) cannot be changed through this
        endpoint. Returns the

        updated journey in the same shape as `GET /journeys/{id}`.
      operationId: updateJourney
      parameters:
        - name: id
          in: path
          required: true
          description: Journey ID.
          schema:
            type: integer
        - 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/UpdateJourneyRequest'
            examples:
              rename:
                summary: Rename
                value:
                  name: Welcome series (v2)
              change_trigger:
                summary: Change the trigger event
                value:
                  trigger:
                    type: event
                    event_name: purchased
        required: true
      responses:
        '200':
          description: Journey updated.
          content:
            application/json:
              examples:
                default:
                  value:
                    id: 42
                    name: Welcome series (v2)
                    description: null
                    status: active
                    trigger:
                      type: event
                      event_name: purchased
                    nodes:
                      - id: 1
                        type: enter
                      - id: 2
                        type: email
                        title: Welcome email
                        message:
                          id: 100
                          from: hello@example.com
                          reply_to: reply@example.com
                          contents:
                            - id: 200
                              locale: null
                              is_default: true
                              subject: Welcome aboard
                              preheader_text: Glad you're here
                      - id: 3
                        type: exit
                    edges:
                      - from: 1
                        to: 2
                      - from: 2
                        to: 3
                    created_at: '2026-03-01T10:00:00Z'
                    updated_at: '2026-03-02T09:30:00Z'
              schema:
                $ref: '#/components/schemas/Journey'
        '404':
          description: Journey not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '409':
          description: >-
            Journey cannot be edited (archived, locked, or built with the legacy
            journey builder).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '422':
          description: Invalid request body, or the trigger event was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    UpdateJourneyRequest:
      type: object
      description: >
        Update a journey's name and/or its trigger event. Omitted fields are
        left unchanged, and an

        empty body returns the journey unchanged. The journey's steps (`nodes`
        and `edges`) cannot be

        changed through this endpoint; any other field is rejected with `422
        Validation error`.
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Journey name. Trimmed before validation; must be non-blank.
        trigger:
          type: object
          description: Replaces 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
      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
                  - filter
                  - ab_test
                  - ab_test_end
              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` or `ab_test` node,
                  identifying the arm the edge belongs to. A `branch` node's
                  arms are `0` and `1`.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    NotFoundError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          enum:
            - not_found
    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.