Revoke a work details share
Identity module
POST/work-detail-shares/{id}/revokeworkDetailShares.revoke
Ends the share at once through `app.revoke_work_detail_share`; the org reads nothing more, and its work_details_sharing consent is withdrawn when this was its last live share. Only the person who gave it revokes it (422 work_detail_share_not_yours). Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- 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, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the work detail share. |
Response 200: 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/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/revoke" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.workDetailShares.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.work_detail_shares.revoke("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos work-detail-shares revoke 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f