Withdraw a shift swap
Crew module
POST/shift-swaps/{id}/withdrawshiftSwaps.withdraw
Withdraws the caller's own swap request. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability crew.swap.request.
- OAuth scopes: crew.
- 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 shift swap. |
Response 200: ShiftSwap
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the shift swap. |
| 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; null when a seed, platform or system process created it. |
| 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; null when a seed, platform or system process updated it. |
| shift_id | string (uuid) | Yes | Identifier of the shift. |
| swap_state | "Proposed" | "Approved" | "Rejected" | "Canceled" | Yes | Swap state. |
| project_id | string (uuid) | Yes | Identifier of the project of the shift, copied from it. |
| requested_by_membership_id | string (uuid) | Yes | Identifier of the membership of the person on the shift who asks to swap. |
| proposed_membership_id | string (uuid) | Yes | Identifier of the membership of the person who would take the shift. |
{
"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",
"shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"swap_state": "Proposed",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"requested_by_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"proposed_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Code samples
curl -X POST "$XOS_BASE_URL/shift-swaps/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/withdraw" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.shiftSwaps.withdraw("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.shift_swaps.withdraw("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos shift-swaps withdraw 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f