Sign in

v19

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-012366102.8 KB
User Journeys

Update User Journey

Update a User Journey. Cannot update User Journeys with a Voided or Rescinded state

patch/api/v2/user_journeys/{id}

Path parameters

idstring uuid required
Example:69ae0e64b02bfe73a44ca479

Request body

expiration_datestring YYYY-MM-DD
custom_fieldsobject

Example request

{
  "expiration_date": "2026-01-01",
  "office_location_id": "69ae0e64b02bfe73a44ca479",
  "custom_fields": {
    "key1": "Hello",
    "key2": "World"
  },
  "documents": [
    {
      "document_type": "offer_letter",
      "document_number": "1234",
      "document_title": "Offer Letter",
      "document_description": "Offer Letter to the Joe",
      "attachments": [
        {
          "file_name": "abc.pdf",
          "file_content_base64": "WW91J3JlIGEgY3VyaW91cyBmZWxsb3cgOy0p"
        }
      ]
    }
  ]
}

Response

The request has succeeded.

idstring uuid required
journey_idstring uuid required
user_idstring 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_atstring YYYY-MM-DD required
expiration_datestring YYYY-MM-DD required

Example response

{
  "id": "69ae0e64b02bfe73a44ca479",
  "journey_id": "69ae0e64b02bfe73a44ca479",
  "user_id": "69ae0e64b02bfe73a44ca479",
  "transition_type": "pre_offer",
  "state": "approved",
  "created_at": "2026-01-01",
  "expiration_date": "2026-01-01",
  "office_location": {
    "id": "69ae0e64b02bfe73a44ca479",
    "external_ids": {
      "workday": "LOCATION-3-69"
    },
    "address1": "123 Main St",
    "address2": "Suite 200",
    "address3": "Building B",
    "city": "New York",
    "state": "NY",
    "region": "Northeast",
    "country": "USA",
    "postal_code": "10001",
    "time_zone": "NZT",
    "latitude": 3.12332,
    "longitude": 3.12332
  },
  "custom_field_values": [
    {
      "id": "1234",
      "value": "custom field value",
      "name": "custom field name",
      "key": "1234"
    }
  ]
}