A comprehensive list of available enumerations and statuses
In this section you will find available enumerations to help you handle different cases in your implementation.
NOTE We are constantly improving our APIs, enabling new functionalities, and new platforms. There might be cases of new items appearing in the lists in the future. Inform us if you spot such situations to help us improve together.
Reservation statuses
JSON location: Reservation.status
docs
Value | Description |
---|---|
pending | Pending Request to Book reservation which needs to be accepted |
pending_voided | The Guest retracted their request, or the guest failed to pay in the window given |
deny | Declined Request to Book reservation |
awaiting_payment pending_payment pending_verification at_checkpoint | States that require guest action. If the guest fails to complete their tasks, this would result in a failed reservation. |
checkpoint_voided | The guest was requested to provide identity verification and they withdrew the reservation request |
failed_verification | Some of the reasons for this status are (1) payment method is not supported or is invalid, (2) we failed to associate guest government issued identification (China only), (3) user is enqueued for ID verification, and (4) the user's government ID was rejected. For example, if after 24 hours the pending_verification reservation does not transition to accepted or pending the system will automatically transition it to failed_verification |
timeout | A required action was not completed in time to confirm a reservation. Ie. the host did not respond to a Request to Book within 24 hours or the guest did not provide a timely payment. |
expired | Corresponds to an expired reservation |
accept | A confirmed reservation |
cancelled_by_host | Reservation was canceled by the host |
cancelled_by_guest | Reservation was canceled by the guest |
cancelled_by_admin | Reservation was canceled by Airbnb admin |
reservation_request_voided | Request to Book was retracted by the guest |
unknown | Reservation is in a broken state |
Webhook actions
A list of all available webhook action
values:
listing.created
listing.changed
listing.deleted
listing.deactivated
listing.reactivated
reservation.created
reservation.changed
channel.activated
review.created
review.submitted
review.published
review.expired
review.changed
review.response_submitted