Request cancellation of a channel reservation

post

https://open-api.guesty.com/v1/reservations-v3/{reservationId}/request-cancellation

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

reservationId

string

required

The Guesty reservation ID

Body Params

reason

string

enum

required

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

subReason

string

enum

required

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

messageToChannel

string

required

Message to be sent to the channel explaining the cancellation

messageToGuest

string

required

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

Responses

200

Cancellation request created successfully

201

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404Returned if the reservation is not found

422Returned if the reservation is not in a valid status for cancellation or if required fields are missing

500Indicates server-side error while processing the request