Cancel appointment.

Cancel an existing appointment. Appointments already in a terminal status (cancelled, completed, or no-show) cannot be cancelled again — unlike editing an appointment, there is no exception for this endpoint; every cancel request on a terminal-status appointment is rejected.

DELETE

/api/partners/v1/community/:community_id/appointments/:appointment_id/

Request

Example requestDELETEapplication/json

curl -X DELETE \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -d '{}' \
    "https://api.funnelleasing.com/api/partners/v1/community/1234/appointments/952/"

Response

Example responseJSON200 · application/json

{
  "success": true
}

Errors

Errors specific to this endpoint

Appointment Not Found (404)

Returned when appointment_id doesn't match an appointment belonging to this community's employee group.

Error responseJSON404 · application/json

{
"error_type": "AppointmentNotFound",
"message": "Could not find appointment with corresponding ID."
}

Terminal Status (400)

Returned when the appointment is already cancelled, completed, or a no-show. The status name shown is the human-readable display value (for example, Completed).

Error responseJSON400 · application/json

{
"error_type": "ValidationError",
"message": "Can't cancel appointments in status 'Completed'"
}