/api/v1/reservations/

post

https://app.staylio.com/api/v1/reservations/

Create a new reservation.

Required fields: id, host_id, check_in_date, check_out_date, guest, properties.

Guest must include at least id and email. If a guest with the given id already exists for this host, it will be updated with the provided data. Otherwise, a new guest is created.

Properties is a list where each item must include at least id and name. Each property is upserted: updated if it exists, created if it does not.

invoice_number defaults to the reservation id if not provided.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

guest

object

Required on create. Guest data with at least id and email. If a guest with this id already exists, it will be updated; otherwise a new guest is created.

properties

array of objects

Required on create. List of property objects, each with at least id and name. If a property with a given id already exists, it will be updated; otherwise a new property is created.

properties

host_id

string

length ≥ 1

Required on create. The host identifier from your system.

invoice_number

string

Optional. Defaults to the reservation id if not provided.

check_in_date

date

required

check_out_date

date

required

string

length ≥ 1

Required on create. Your unique reservation identifier.

invoice_total

string | null

invoice_total_with_deposits

string | null

payment_status

enum

paid_in_full - Paid in Full
not_paid - Not Paid
partially_paid - Partially Paid
refunded - Refunded
partially_refunded - Partially Refunded
cancelled - Cancelled
deleted - Deleted

amount_paid

string | null

check_in_time

string | null

checked_in

boolean

checked_in_at

date-time | null

check_out_time

string | null

checked_out

boolean

checked_out_at

date-time | null

adults

int64 | null

0 to 4294967295

children

int64 | null

0 to 4294967295

pets

int64 | null

0 to 4294967295

booking_source

string | null

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Language

Credentials

Header

Loading…

Response

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

application/json

201