Cancel Appointment

Required scope: appointment:cancel

Cancels a scheduled appointment and reopens any linked work order. Cancelling an already-cancelled appointment succeeds and returns the appointment unchanged. A completed appointment cannot be cancelled.

Generated Reference

POST /public-api/publicapi.v1.Appointment/CancelAppointment

Cancels a scheduled, locally created direct appointment and reopens any linked work order. Cancelling an already-cancelled appointment succeeds.

Request CancelAppointmentRequest

Response CancelAppointmentResponse

CancelAppointmentRequest

Field	Type	Description
id	string	Appointment to cancel.

CancelAppointmentResponse

Field	Type	Description
appointment	Appointment	The cancelled appointment.

Related Types

Appointment

Field	Type	Description
id	string	Appointment identifier.
customer_id	string	Customer the appointment is booked for.
agenda_id	string	Agenda the appointment belongs to.
appointment_type_id	string	Appointment type applied to the appointment.
assigned_member_id	string	Member currently assigned, or empty when unassigned.
scheduled_start_at	int64	Scheduled start as unix seconds.
scheduled_end_at	int64	Scheduled end as unix seconds.
duration_minutes	int32	Scheduled duration in minutes.
status	AppointmentStatus	Current lifecycle status.
notes	string	Free-text notes stored on the appointment.
created_at	int64	Unix seconds when the appointment was created.
updated_at	int64	Unix seconds when the appointment was last updated.

{
  "id": "<appointment-id>"
}