Skip to content

Cancel time off

DELETE
/time-off/{id}
curl --request DELETE \
--url https://example.com/time-off/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

A driver can withdraw their own request still waiting for a yes, and it comes off at once. Their own that is booked, and has not started, is not cancelled: it becomes a request to cancel, cancelRequestedAt is set, and it stays booked, counting as booked, until the office approves the cancellation. Asking again while one waits changes nothing. The office can cancel any at once, which is how a sick day booked by mistake comes off.

id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Cancelled, or for a driver’s booked time off, cancelling it asked for

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
userId
required
string
userName
required
string
kind
required
string
Allowed values: holiday sickness other
startsOn
required
string format: date
endsOn
required
string format: date
halfStart
required
boolean
halfEnd
required
boolean
note
required
string | null
status
required
string
Allowed values: requested approved declined cancelled
days
required
number
unpaidDays
required
number
decidedByName
required
string | null
decidedAt
required
string | null format: date-time
cancelRequestedAt
required
string | null format: date-time
createdAt
required
string format: date-time

Example

{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"kind": "holiday",
"status": "requested"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not found

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Conflict

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}