Create a work detail share

Identity module

POST/work-detail-sharesworkDetailShares.create

The caller's consent to share chosen categories of their work details with the org that engages them, for one engagement, under a work_details_sharing consent record (Section 14.3). Creating a share for an engagement that already has one replaces its categories; fewer categories is a partial revocation. Revoke ends it at once and withdraws the org's consent with its last share. Shares cannot be made once the engagement is Complete or Canceled (422 work_detail_share_closed). The person and the engaging org read shares; only the person writes them. Creates a work detail share. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability me.work_details.write.
OAuth scopes: me.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: WorkDetailShareCreate

workDetailShares.create: WorkDetailShareCreate
Field	Type	Required	Description
engagement_id	string (uuid)	Yes	Identifier of the engagement the share serves; the caller must be its person.
categories	array of WorkDetailCategory	Yes	Categories shared.

{
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "categories": [
    "Dietary Needs",
    "Emergency Contacts"
  ]
}

Response 201: WorkDetailShare

workDetailShares.create: WorkDetailShare
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the work detail share.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row.
engagement_id	string (uuid)	Yes	Identifier of the engagement the share serves; the caller must be its person.
person_id	string (uuid)	Yes	Identifier of the person sharing.
consent_record_id	string (uuid)	Yes	Identifier of the work_details_sharing consent record for the org.
categories	array of WorkDetailCategory	Yes	Categories shared.
shared_at	string (date-time)	Yes	When the share was given.
revoked_at	string (date-time) \| null	Yes	When the person revoked it; null while it stands.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "consent_record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "categories": [
    "Dietary Needs",
    "Emergency Contacts"
  ],
  "shared_at": "2026-10-08T14:30:00Z",
  "revoked_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X POST "$XOS_BASE_URL/work-detail-shares" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","categories":["Dietary Needs","Emergency Contacts"]}'

const { data } = await xos.workDetailShares.create({
    "engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "categories": [
      "Dietary Needs",
      "Emergency Contacts"
    ]
  });

response = xos.work_detail_shares.create({"engagement_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "categories": ["Dietary Needs", "Emergency Contacts"]})

xos work-detail-shares create --data '{"engagement_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","categories":["Dietary Needs","Emergency Contacts"]}'