CalryOTA Docs
Reservation

Cancel a reservation

Cancels an existing reservation.

DELETE
/api/v1/reservation/{id}

Authorization

x-calry-api-key
x-calry-api-key<token>

In: header

Path Parameters

id*string

ID of the reservation to cancel

Query Parameters

cancelledBy?string

Who asked for the cancellation (tenant API keys). Send guest when the guest cancels: the booked terms then set the charge. A host or system cancellation records no charge — the refund is the host's call. Left out, who cancelled is recorded as unknown and nothing is charged. Channel API keys always cancel as the channel.

Value in"guest" | "host" | "system"

Header Parameters

x-calry-tenant-id?string

Optional tenant ID to specify which tenant to operate as. Controls which reservations are accessible. If not provided, the default tenant will be used.

Response Body

application/json

application/json

curl -X DELETE "https://example.com/api/v1/reservation/123e4567-e89b-12d3-a456-426614174000"
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "CANCELLED",
  "cancelledAt": "2026-12-01T10:00:00.000Z",
  "cancelledBy": "GUEST",
  "cancellationCharge": {
    "penaltyPercentage": 50,
    "penaltyAmount": 117,
    "refundPercentage": 50,
    "refundAmount": 117,
    "currency": "EUR"
  }
}
Empty
{
  "timestamp": "2025-03-05T11:45:49.631Z",
  "path": "<URL_PATH>",
  "message": "Authentication failed",
  "details": []
}
Empty