Documentation

Check In to a Reservation

POST /reservations/{reservation_id}/checkin

Checks in to a reservation with the specified ID.

Request Body

Field Type Required Description
allow_multiple boolean No Whether to allow multiple check-ins after this initial one
auto_end boolean No Whether to apply the resourceโ€™s automatic session end setting. Defaults to true.
source string No The source of the check-in
metrics object No Additional metrics to record with the check-in
return_data boolean No Whether to return data about the created actual usage record

Path Parameters

Parameter Type Required Description
reservation_id string Yes The ID of the reservation to check in

Response

Success Response (200 OK)

If return_data is true, response body contains data about the created actual usage record.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Invalid request fields
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to check in this reservation
  • 404 Not Found: Reservation with the specified ID does not exist

See the Actual Usage API overview for related endpoints.