Skip to content

Update a work details

Identity module

PATCH/work-details/{id}workDetails.update

The caller's own work details (Section 4.5.6 item 10): uniform sizes, dietary and accessibility needs and the travel profile. Read and written only by the person; an engaging org sees a category only while the person shares it with that engagement. The passport number is Restricted and encrypted: it is written here, always read masked, and shown only through the logged revealPassport action. One live row per person (409 on a second). Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

workDetails.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work details.

Request body: WorkDetailsUpdate

workDetails.update: WorkDetailsUpdate
FieldTypeRequiredDescription
shirt_sizeGarmentLetterSize | nullNo
jacket_sizeGarmentLetterSize | nullNo
pants_sizestring | nullNoPants size as the person writes it.Constraints: length 1 to 20
shoe_sizestring | nullNoShoe size with its system.Constraints: length 1 to 20
glove_sizeGarmentLetterSize | nullNo
hat_sizestring | nullNoHat size as the person writes it.Constraints: length 1 to 20
uniform_notesstring | nullNoAnything else about fit.Constraints: length 1 to 500
dietary_needsarray of DietaryNeedNoDietary needs, each once, in enum order.
allergiesstring | nullNoAllergies in the person's words, with how severe.Constraints: length 1 to 500
dietary_notesstring | nullNoOther dietary notes.Constraints: length 1 to 500
accessibility_needsarray of AccessibilityNeedNoAccessibility needs, each once, in enum order.
accessibility_notesstring | nullNoAccessibility needs in the person's words.Constraints: length 1 to 1000
seat_preferenceSeatPreference | nullNo
meal_preferencestring | nullNoPreferred in-flight meal.Constraints: length 1 to 100
home_airportstring | nullNoIATA airport code.Constraints: pattern ^[A-Z]{3}$
passport_numberstring | nullNoPassport number, write-only: letters and digits are kept and encrypted. Send null to clear it.Constraints: length 5 to 30
passport_issuing_countrystring | nullNoCountry that issued the passport.Constraints: pattern ^[A-Z]{2}$
passport_expires_onstring (date) | nullNoDay the passport expires.
passport_namestring | nullNoName exactly as printed in the passport.Constraints: length 1 to 200
{
  "pants_size": "32x32",
  "shoe_size": "US 10.5",
  "hat_size": "7 1/4",
  "uniform_notes": "Prefers a relaxed cut.",
  "dietary_needs": [
    "Vegan"
  ],
  "allergies": "Peanuts, severe",
  "dietary_notes": "No pork.",
  "accessibility_needs": [
    "Seating"
  ],
  "accessibility_notes": "Needs a seat near the stage door.",
  "meal_preference": "Vegetarian (VGML)",
  "home_airport": "MIA",
  "passport_number": "YA0000TEST",
  "passport_issuing_country": "US",
  "passport_expires_on": "2026-10-08",
  "passport_name": "IVY MARCHETTI"
}

Response 200: WorkDetails

workDetails.update: WorkDetails
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the work details.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the person the work details belong to; always the caller.
shirt_sizeGarmentLetterSize | nullYes
jacket_sizeGarmentLetterSize | nullYes
pants_sizestring | nullYesPants size as the person writes it.Constraints: length 1 to 20
shoe_sizestring | nullYesShoe size with its system.Constraints: length 1 to 20
glove_sizeGarmentLetterSize | nullYes
hat_sizestring | nullYesHat size as the person writes it.Constraints: length 1 to 20
uniform_notesstring | nullYesAnything else about fit.Constraints: length 1 to 500
dietary_needsarray of DietaryNeedYesDietary needs, each once, in enum order.
allergiesstring | nullYesAllergies in the person's words, with how severe.Constraints: length 1 to 500
dietary_notesstring | nullYesOther dietary notes.Constraints: length 1 to 500
accessibility_needsarray of AccessibilityNeedYesAccessibility needs, each once, in enum order.
accessibility_notesstring | nullYesAccessibility needs in the person's words.Constraints: length 1 to 1000
seat_preferenceSeatPreference | nullYes
meal_preferencestring | nullYesPreferred in-flight meal.Constraints: length 1 to 100
home_airportstring | nullYesIATA airport code.Constraints: pattern ^[A-Z]{3}$
passport_numberstring | Masked | nullYes
passport_number_last4string | nullYesLast four characters of the passport number.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
passport_issuing_countrystring | nullYesCountry that issued the passport.Constraints: pattern ^[A-Z]{2}$
passport_expires_onstring (date) | nullYesDay the passport expires.
passport_namestring | nullYesName exactly as printed in the passport.Constraints: length 1 to 200
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shirt_size": "XXS",
  "jacket_size": "XXS",
  "pants_size": "32x32",
  "shoe_size": "US 10.5",
  "glove_size": "XXS",
  "hat_size": "7 1/4",
  "uniform_notes": "Prefers a relaxed cut.",
  "dietary_needs": [
    "Vegan"
  ],
  "allergies": "Peanuts, severe",
  "dietary_notes": "No pork.",
  "accessibility_needs": [
    "Seating"
  ],
  "accessibility_notes": "Needs a seat near the stage door.",
  "seat_preference": "Window",
  "meal_preference": "Vegetarian (VGML)",
  "home_airport": "MIA",
  "passport_number": "YA0000TEST",
  "passport_number_last4": "TEST",
  "passport_issuing_country": "US",
  "passport_expires_on": "2026-10-08",
  "passport_name": "IVY MARCHETTI"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/work-details/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"pants_size":"32x32","shoe_size":"US 10.5","hat_size":"7 1/4","uniform_notes":"Prefers a relaxed cut.","dietary_needs":["Vegan"],"allergies":"Peanuts, severe","dietary_notes":"No pork.","accessibility_needs":["Seating"],"accessibility_notes":"Needs a seat near the stage door.","meal_preference":"Vegetarian (VGML)","home_airport":"MIA","passport_number":"YA0000TEST","passport_issuing_country":"US","passport_expires_on":"2026-10-08","passport_name":"IVY MARCHETTI"}'
const { data, etag } = await xos.workDetails.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "pants_size": "32x32",
    "shoe_size": "US 10.5",
    "hat_size": "7 1/4",
    "uniform_notes": "Prefers a relaxed cut.",
    "dietary_needs": [
      "Vegan"
    ],
    "allergies": "Peanuts, severe",
    "dietary_notes": "No pork.",
    "accessibility_needs": [
      "Seating"
    ],
    "accessibility_notes": "Needs a seat near the stage door.",
    "meal_preference": "Vegetarian (VGML)",
    "home_airport": "MIA",
    "passport_number": "YA0000TEST",
    "passport_issuing_country": "US",
    "passport_expires_on": "2026-10-08",
    "passport_name": "IVY MARCHETTI"
  }, { ifMatch: etag });
response = xos.work_details.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"pants_size": "32x32", "shoe_size": "US 10.5", "hat_size": "7 1/4", "uniform_notes": "Prefers a relaxed cut.", "dietary_needs": ["Vegan"], "allergies": "Peanuts, severe", "dietary_notes": "No pork.", "accessibility_needs": ["Seating"], "accessibility_notes": "Needs a seat near the stage door.", "meal_preference": "Vegetarian (VGML)", "home_airport": "MIA", "passport_number": "YA0000TEST", "passport_issuing_country": "US", "passport_expires_on": "2026-10-08", "passport_name": "IVY MARCHETTI"}, if_match=etag)
xos work-details update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"pants_size":"32x32","shoe_size":"US 10.5","hat_size":"7 1/4","uniform_notes":"Prefers a relaxed cut.","dietary_needs":["Vegan"],"allergies":"Peanuts, severe","dietary_notes":"No pork.","accessibility_needs":["Seating"],"accessibility_notes":"Needs a seat near the stage door.","meal_preference":"Vegetarian (VGML)","home_airport":"MIA","passport_number":"YA0000TEST","passport_issuing_country":"US","passport_expires_on":"2026-10-08","passport_name":"IVY MARCHETTI"}' --if-match auto