Skip to content
XOS Developers

Delete a shift

Crew module

DELETE/shifts/{id}shifts.delete

A staffed crew block. A shift cannot end before it starts. Soft-deletes the shift: it moves to Trash and can be restored for its table's retention period.

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

Path and query parameters

shifts.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the shift.

Response 204: no body.

Code samples

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