Appointments

Update an appointment

Updates an existing appointment. Only the fields provided will be changed. If the start time or end time changes, a rescheduled notification is automatically sent.

Required permission: assigned_appointment_write or unassigned_appointment_write

put/api/v1/appointments/{id}

Request

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

Path parameters

idinteger required

The unique ID of the appointment

Headers

Api-Keystring required

Your Integration Key

Request body

guest_namestring

Guest name

guest_emailstring

Guest email address

guest_phonestring

Guest phone number

additional_guestsstring

Additional guest names or details

starts_at_datestring

New appointment date (YYYY-MM-DD)

starts_at_timestring

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

length_in_minutesinteger

Duration in minutes

locationstring

Appointment location

location_detailsstring

Additional location details

private_notesstring

Private internal notes

custom_titlestring

Custom title override

brand_idinteger

Brand ID

Response

appointment updated

Changes

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