Mark the status of an appointment as checked-in

This API helps you to mark the status of an appointment as checked-in. By doing so, you can provide your guests the option to self check-in for their scheduled appointments from your CMA and custom Webstore.

You must specify appropriate data for the appointment_group_id parameter.

Response Details

NameTypeDescription
successbooleanIndicates whether the status of the specified appointment was successfully marked as checked-in.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

error Object

codemessage
410Appointment could not be found.
428Invoice does not exist.
4051User cannot access.
734Check-in cannot be added for closed invoice.
502Invoice center is not a valid center. Organization ID does not match with invoice's organization ID.
727You cannot check-in guests for appointments scheduled for a future date.
Language
Authorization
Header
Click Try It! to start a request and see the response here!