Cancel an appointment
DELETE/v1/agent/appointments/:appointmentId
Cancels the reservation and removes its Google event while preserving its audit record. Pending requests become rejected. Current version and Idempotency-Key required. Version/state conflicts return 400. Idempotency-Key is unique across the application: retries must keep the same appointment, effective action and request body. Reuse for another target/action/body returns 400 INVALID_APPOINTMENT_ACTION_PAYLOAD. Use a new key for each new action.
Request
Responses
- 200
- 400
- 401
- 404
- 503
Successful response.
IDEMPOTENCY_KEY_REQUIRED, INVALID_APPOINTMENT_ACTION_PAYLOAD (including incompatible key reuse), APPOINTMENT_VERSION_CONFLICT, APPOINTMENT_STATE_CONFLICT, APPOINTMENT_SLOT_UNAVAILABLE, APPOINTMENT_ANSWERS_INVALID, APPOINTMENT_CALENDAR_BUSY, APPOINTMENT_CONVERSATION_NOT_APPLICABLE, or APPOINTMENT_ACTION_FAILED. Review validation before retrying. Customer notification failures are reported independently in messageDelivery.
Missing or invalid application API key.
Unknown or unavailable page, service, workspace or appointment.
Calendar temporarily unavailable; retry the same operation ID.