---
title: "Update User Journey"
method: PATCH
path: "/api/v2/user_journeys/{id}"
tags: ["User Journeys"]
---

# Update User Journey

`PATCH /api/v2/user_journeys/{id}`

Update a User Journey

## Path parameters

- `id` string, required

## Request body

- UserJourneyUpdate
  - `journey_id` string, required
  - `state` 'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed'
  - `created_at` string
  - `office_location_id` OfficeLocationId
    - `workday` string
    - `id` string, required
    - `external_ids` object, required
      - `hris_id` string
    - `address1` string
    - `address2` string
    - `address3` string
    - `city` string
    - `state` string
    - `region` string
    - `country` string
    - `postal_code` string
    - `time_zone` string
    - `latitude` number, float
    - `longitude` number, float
  - `custom_fields` CustomFieldsValueObject
    - `id` string, required
    - `value` string, required
    - `name` string, required
    - `key` string, required
  - `documents` Document[]
    - `document_type` string
    - `document_number` string
    - `document_title` string
    - `document_description` string
    - `issuer` string
    - `issuer_city` string
    - `issuer_state` string
    - `issuer_country` string
    - `issued_date` string, date
    - `expiry_date` string, date
    - `attachments` Attachment[]
      - `file_name` string
      - `file_content_base64` string
      - `responses` object — Responses provided in PDF form fields (only present when attachment is a PDF with form fields)
        - `field_name_1` string
        - `field_name_2` string

## Response `200`

The request has succeeded.

- UserJourney
  - `id` string, required
  - `journey_id` string, required
  - `journey_type` string
  - `user_id` string
  - `state` 'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed'
  - `created_at` string
  - `office_location` OfficeLocationId
    - `workday` string
    - `id` string, required
    - `external_ids` object, required
      - `hris_id` string
    - `address1` string
    - `address2` string
    - `address3` string
    - `city` string
    - `state` string
    - `region` string
    - `country` string
    - `postal_code` string
    - `time_zone` string
    - `latitude` number, float
    - `longitude` number, float
  - `custom_field_values` CustomFieldsValueObject
    - `id` string, required
    - `value` string, required
    - `name` string, required
    - `key` string, required

## Other responses

- `404` — The server cannot find the requested resource.
- `422` — Client error

## Changes

- **2025-05-19** `805744a185fa` — 1 info
  - endpoint added
- **2024-06-11** `6cde27481f55` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/xpand-io/apis/xpand-api/changes/api/v2/user_journeys/:id/patch.md)

---

[API](https://skmtc.dev/xpand-io/apis/xpand-api.md) · [All operations](https://skmtc.dev/xpand-io/apis/xpand-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xpand-io/xpand-api/revisions/805744a185fa/schema)