---
title: "Create User Journey"
method: POST
path: "/api/v2/user_journeys"
tags: ["User Journeys"]
---

# Create User Journey

`POST /api/v2/user_journeys`

Create a User Journey

## Request body

- RequestsUserJourneyCreate
  - `transition_type` 'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding'
  - `user_id` union
    - string, uuid
    - object
      - `workday` string
  - `state` 'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed' | 'voided'
  - `expiration_date` string, YYYY-MM-DD
  - `office_location_id` union
    - string, uuid
    - object
      - `workday` string
  - `custom_fields` object
  - `documents` object[]
    - `document_type` string
    - `document_number` string
    - `document_title` string
    - `document_description` string
    - `attachments` object[]
      - `file_name` string
      - `file_content_base64` string, Base64

## Response `201`

The request has succeeded and a new resource has been created as a result.

- ResponsesUserJourneyCreate
  - `id` string, uuid, required
  - `journey_id` string, uuid, required
  - `user_id` string, uuid, required
  - `transition_type` 'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding', required
  - `state` 'draft' | 'needs_attention' | 'pending_approval' | 'approved' | 'rejected' | 'rescinded' | 'user_pending' | 'submitted' | 'declined' | 'completed' | 'voided', required
  - `created_at` string, YYYY-MM-DD, required
  - `expiration_date` string, YYYY-MM-DD, required
  - `office_location` ModelsOfficeLocation, required
    - `id` string, uuid, required
    - `external_ids` object
      - `workday` string
    - `address1` string
    - `address2` string
    - `address3` string
    - `city` string, required
    - `state` string
    - `region` string
    - `country` string, required
    - `postal_code` string
    - `time_zone` string
    - `latitude` number, float
    - `longitude` number, float
  - `custom_field_values` object[], required
    - `id` string
    - `value` string
    - `name` string
    - `key` string

## Other responses

- `422` — Client error

---

[API](https://skmtc.net/xpand-io/apis/xpand-api.md) · [All operations](https://skmtc.net/xpand-io/apis/xpand-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xpand-io/xpand-api/versions/85bece7875fd/schema)