postGuest

post

https://api.yanoljacloudsolution.com/api/v1/postGuest

Creates a guest profile on a reservation. Optional free-text notes are Luhn-guarded.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

hotelCode

string

required

Unique code of the property (digits only, max 11)

Body Params

reservationID

string

required

Reservation number (alphanumeric and hyphens, max 40)

guestFirstName

string

required

Guest first name (max 120)

guestLastName

string

required

Guest last name (max 120)

guestEmail

string

required

Guest email (max 254)

guestCountry

string

required

Two-letter ISO country code

guestGender

string

enum

Guest gender

Allowed:

guestPhone

string

Guest phone (digits and +()- only, max 80)

guestCellPhone

string

Guest mobile phone (digits and +()- only, max 80)

guestAddress

string

Guest address (max 400)

guestCity

string

City (max 120)

guestState

string

State / province (max 120)

guestZip

string

Postal code (max 40)

guestBirthDate

date

Date of birth (YYYY-MM-DD)

guestDocumentType

string

Identity document type configured for the property

guestDocumentNumber

string

Identity document number (max 120)

guestDocumentIssuingCountry

string

Document issuing country (2-letter ISO)

guestDocumentIssuingCity

string

Document issuing city (max 120)

guestDocumentExpirationDate

date

Document expiration date (YYYY-MM-DD)

guestNote

string | null

Note on the guest profile. Max 4000 characters. Numeric values longer than 12 characters that are considered valid by Luhn's algorithm (mod 10) are rejected. Rejected requests return HTTP 400 with code GUEST_NOTE_CONTAINS_PAYMENT_DATA.

reservationNote

string | null

Optional reservation note. Max 4000 characters. Numeric values longer than 12 characters that are considered valid by Luhn's algorithm (mod 10) are rejected. Rejected requests return HTTP 400 with code GUEST_NOTE_CONTAINS_PAYMENT_DATA.

companyName

string

Guest's company name (max 200)

billingCompany

string

Billing company name on file (max 200)

billingCompanyTaxId

string

Billing company tax ID (requires billingCompany)

registrationNo

string

Guest registration number (max 80)

vipStatus

string

VIP status configured for the property

paymentMethod

string

Payment method configured for the property

purposeofVisit

string

Purpose of visit configured for the property

vehicleNo

string

Vehicle number (max 80)

vehicleLicenseNo

string

Vehicle license number (max 80)

vehicleState

string

Vehicle state (max 120)

userID

string

Optional user ID for activity logging. If omitted when saving a note, the note is recorded under the property's admin user.

Responses

200200 response

400Bad Request

401Unauthorized

403Forbidden

404Not Found

409Conflict

429Too Many Requests

500Internal Server Error