Skip to main content
POST
Create a new session

Headers

X-AVP-SessionDuration
string

The custom duration of the session.

X-AVP-Impersonation
string

The impersonation.

Body

The request.

engineId
string
required

The engine for which to create a session. This is the only property that is required to create a session.

guestSelectionMode
enum<string>
required

The guest selection mode (per room or per booking).

Available options:
Default,
PerRoom,
PerBooking
display
object
required

The desired display context.

Example:
context
object
required

This represent the parameters used to configure future call to the service. It represents more or less the data entered by the final customer.

Example:
metadata
object
required

Response

Indicates that the session was created correctly

sessionId
string<uuid>
required
warnings
string[]
required

Possible values are : InvalidStayPeriod, InvalidRateId, InvalidRoomId, InvalidPromoCode, InvalidGuests