Create Reservation
POST /v1/reservations
Requests a reservation to be placed on a resource for a given time period.
To receive the result of a reservation request, a subscription on reservationResult webhook events are required.
Headers
Authorization
Bearer <token>
x-api-key
<api key>
Body
userIdstring(uuid) (required)
Identifier of the user to make the reservation on behalf of.
resourceIdstring(uuid) (required)
Identifier of the resource that should be reserved.
startTimestring(date-time) (required)
Date and time when the reservation starts (in ISO 8601-format compliant date with time expressed in UTC, e.g yyyy-mm-ddThh:mmZ). The time portion of startTime must match the start time of an available slot according to the reservation schedule used for the resource.
endTimestring(date-time) (required)
Date and time when the reservation ends (in ISO 8601-format compliant date with time expressed in UTC, e.g yyyy-mm-ddThh:mmZ). The time portion of endTime must match the end time of an available slot according to the reservation schedule used for the resource.
Response
202 Accepted
The reservation request was accepted and queued for execution.
Body
correlationIdstring(uuid)
Transactional identifier of the reservation request. Can be used to match the corresponding reservationResult webhook event where the actual result of the reservation request is delivered.
timestamp string(date-time)
The time when the operation was accepted.
Last updated