Skip to content

Delete a work details

Identity module

DELETE/work-details/{id}workDetails.delete

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). Soft-deletes the work details: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.work_details.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

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

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/work-details/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.workDetails.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.work_details.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos work-details delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f