Update a work detail share

Módulo Identity

PATCH/work-detail-shares/{id}workDetailShares.update

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. 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.

Requiere la capacidad me.work_details.write.
Alcances de OAuth: me.
Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

workDetailShares.update: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the work detail share.

Cuerpo de la solicitud: WorkDetailShareUpdate

workDetailShares.update: WorkDetailShareUpdate
Campo	Tipo	Obligatorio	Descripción
categories	array of WorkDetailCategory	No	Categories shared.

{
  "categories": [
    "Dietary Needs",
    "Emergency Contacts"
  ]
}

Respuesta 200: WorkDetailShare

workDetailShares.update: WorkDetailShare
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the work detail share.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
engagement_id	string (uuid)	Sí	Identifier of the engagement the share serves; the caller must be its person.
person_id	string (uuid)	Sí	Identifier of the person sharing.
consent_record_id	string (uuid)	Sí	Identifier of the work_details_sharing consent record for the org.
categories	array of WorkDetailCategory	Sí	Categories shared.
shared_at	string (date-time)	Sí	When the share was given.
revoked_at	string (date-time) \| null	Sí	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"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/work-detail-shares/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 '{"categories":["Dietary Needs","Emergency Contacts"]}'

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

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

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