Appointments

Create an appointment

Creates a new appointment for the business. The appointment is assigned to the authenticated user by default, or to a specific user via user_id.

The location field specifies where the appointment takes place (e.g., "Phone", "In Person", a Zoom link, etc.).

Required permission: appointment_create

post/api/v1/appointments

Request

  • Base URL: https://api.checkcherry.com
  • URL: https://api.checkcherry.com/api/v1/appointments
  • Auth: none declared. Required headers: Api-Key

Headers

Api-Keystring required

Your Integration Key

Request body

guest_namestring required

Guest name

guest_emailstring required

Guest email address

guest_phonestring

Guest phone number

additional_guestsstring

Additional guest names or details

starts_at_datestring required

Appointment date (YYYY-MM-DD)

starts_at_timestring required

Appointment start time (e.g., "2:00 PM")

length_in_minutesinteger required

Duration in minutes

locationstring

Appointment location (e.g., "Phone", "In Person")

private_notesstring

Private internal notes

messagestring

Message to the guest

user_idinteger

Staff member ID to assign (defaults to authenticated user)

brand_idinteger

Brand ID (defaults to the primary brand)

user_appointment_calendar_idinteger

Appointment calendar ID for scheduling

created_via'quick_add' | 'widget' | 'app' required

How the appointment was created

Response

appointment created

Changes

No recorded changes to this operation across all 2 revisions of this API.