Cancel Shift

DELETE {{base_url}}/api/v3/shifts/{{SHIFT_ID}}

Required scope: shifts:write

Cancels (soft-deletes) an operator-owned shift. Requires admin credentials. This action cannot be applied to a Toast-clocked shift and returns 409 in that case. Missing and foreign-operator shift IDs return 404.

Examples

curl --request DELETE '${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000'

const response = await fetch("${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000", {
  "method": "DELETE",
  "headers": {}
})
const data = await response.json()

import requests

response = requests.request(
    "DELETE",
    "${base_url}/api/v3/shifts/550e8400-e29b-41d4-a716-446655440000",
    headers={},
)
response.raise_for_status()

Saved responses

{
  "type": "success",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "deleted": true
  }
}

{
  "type": "error",
  "message": "Toast-managed shifts cannot be deleted",
  "status": 409
}

{
  "type": "error",
  "message": "Shift not found",
  "status": 404
}