Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

Request cancellation of a channel reservation

Request cancellation of a channel reservation with a reason and message to the guest and channel. The reservation must be from a channel and in 'confirmed' status to be cancelled.

post/reservations-v3/{reservationId}/request-cancellation

Path parameters

reservationIdstring required
Example:5f92cbf10cf217478ba93561

The Guesty reservation ID

Request body

reason'DECLINE_REASON_HOST_DOUBLE' | 'DECLINE_REASON_HOST_CHANGE' | 'DECLINE_REASON_HOST_UNAUTHORIZED_PARTY' | 'DECLINE_REASON_HOST_BEHAVIOR' | 'DECLINE_REASON_HOST_OTHER' | 'DECLINE_REASON_HOST_ASKED' | 'DECLINE_REASON_COVID19_HOST' | 'DECLINE_REASON_HOST_BAD_FIT' | 'DECLINE_REASON_HOST_BAD_REVIEWS_SPARSE_PROFILE' required

The primary reason for cancelling the reservation. This is required by the channel to process the cancellation

subReason'DECLINE_REASON_HOST_EMERGENCY' | 'DECLINE_REASON_HOST_HOST_UNAVAILABLE' | 'DECLINE_REASON_HOST_DOUBLE_BOOKED' | 'DECLINE_REASON_HOST_RESERVATION_LENGTH' | 'DECLINE_REASON_HOST_DIFFERENT_PRICE' | 'DECLINE_REASON_HOST_UNAUTHORIZED_PARTY' | 'DECLINE_REASON_HOST_PARTY_REVIEWS' | 'DECLINE_REASON_HOST_PARTY_INDICATION' | 'DECLINE_REASON_HOST_BEHAVIOR_REVIEWS' | 'DECLINE_REASON_HOST_BEHAVIOR_INDICATION' | 'DECLINE_REASON_HOST_BEHAVIOR_OTHER' | 'DECLINE_REASON_HOST_GUEST_PROFILE' required

The specific sub-reason that provides more detail about the cancellation. This helps the channel understand the context better

messageToChannelstring required

Message to be sent to the channel explaining the cancellation

messageToGueststring required

Message to be sent to the guest explaining the cancellation. This will be communicated to the guest through the channel

Example request

{
  "reason": "DECLINE_REASON_HOST_CHANGE",
  "subReason": "DECLINE_REASON_HOST_EMERGENCY",
  "messageToChannel": "Due to an emergency situation, we need to cancel this reservation",
  "messageToGuest": "We sincerely apologize, but due to unforeseen circumstances, we must cancel your reservation. We hope to host you in the future"
}

Response

Cancellation request created successfully