postReservation

post

https://api.cloudbeds.com/api/v1.3/postReservation

Adds a reservation to the selected property

Form Data

propertyID

string | null

Property ID

sourceID

string | null

The third-party source ID for this reservation.

thirdPartyIdentifier

string | null

If it was received from a booking channel, this can be an identifier from that channel.

startDate

date

Check-In date.

endDate

date

Check-Out date.

guestFirstName

string

First name of the guest

guestLastName

string

Last name of the guest

guestGender

string | null

enum

Allowed:

guestCountry

string

Valid ISO-Code for Country (2 characters)

guestZip

string

ZIP Code

guestEmail

string

Guest email

guestPhone

string | null

Guest main phone number

guestRequirements

array of objects | null

Object with guest requirements information.

guestRequirements

estimatedArrivalTime

string | null

Estimated Arrival Time, 24-hour format.

rooms

array of objects

Array with quantity of rooms

rooms

adults

array of objects

Array with number of adults

adults

children

array of objects

Array with number of children

children

paymentMethod

string

enum

Payment Method of choice.

Allowed:

cardToken

string | null

Credit Card identifier. Payment Method must be credit. This field should be filled with credit card identifier according to gateway. Only available for Stripe and should send the Customer ID.

paymentAuthorizationCode

string | null

Transaction identifier. Payment Method must be credit. This field should be filled with transaction identifier according to gateway. Only available for Stripe and it should be filled with Charge ID associated to the Payment Intent.

customFields

array of objects | null

Array with custom fields information

customFields

promoCode

string | null

Promotional code. Required for specials and packages that uses it. "rateID" parameter required for using "promoCode".

allotmentBlockCode

string | null

Allotment block code to add reservation to allotment block.

groupCode

string | null

Code from the Aggregate Allotment block the reservation will be added to.

dateCreated

date-time | null

Date reservation was made. Defaults to current date if omitted.

sendEmailConfirmation

boolean | null

Defaults to true

Send confirmation email to guest.

Response

200200 Response