Documentation

Cancel Single Reservation

POST /reservation/{reservation_id}/cancel

Cancels a reservation by its ID. Requires edit and cancellation permission for this reservation.

Path Parameters

Parameter Type Required Description
reservation_id string Yes ID of the reservation to cancel.

Request Body

Field Type Required Description
reason string No The reason for the cancellation
silently boolean No Set true to suppress cancellation notifications. The flag is honored for site moderators and administrators.

Response

Success Response (200 OK)

data identifies the cancelled reservation and whether it was a maintenance booking.

{
  "api_version": 1,
  "action": "unknown",
  "status": "success",
  "data": {
    "maintenance": false,
    "reservation_id": "RESERVATION_ID"
  }
}

Error Responses

  • 400 Bad Request: Invalid request
  • 403 Forbidden: Caller cannot cancel the reservation
  • 422 Unprocessable Entity: Invalid request fields
  • 401 Unauthorized: Authentication failed
  • 404 Not Found: Reservation with the specified ID does not exist

See the Reservations API overview for related endpoints and shared data structures.