Skip to main content
POST
Cancel a booked call
Cancel a booked call. Runs the same lifecycle pipeline as a cancellation performed in the Aura dashboard:
  • The calendar event is deleted and guests are notified
  • Cancellation emails and reminder supersede are dispatched
  • Any scheduled meeting recording is torn down
  • The call.cancelled webhook fires to all subscribers (do not expect a second event from this endpoint — the platform pipeline is the single emitter)
Idempotency: cancelling an already-cancelled (or declined) call returns 200 with the current call state and performs no mutation. Terminal outcomes: calls whose deal already resolved (closed / lost) cannot be cancelled — the request fails with 409 CALL_NOT_CANCELLABLE. Upstream failures: if the upstream calendar provider rejects the cancellation the request fails with 422 EXTERNAL_API_ERROR; if the provider is degraded it fails with 502 EXTERNAL_API_ERROR. No partner data is changed in either case.

Path Parameters

id
string
required

Call ID (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
reason
string

Optional cancellation reason, recorded on the call and included in guest-facing notifications

Maximum string length: 500
Example:

"Prospect requested cancellation"

Response

Call cancelled (or already cancelled — idempotent). Returns the current call state.

data
object
required
success
enum<boolean>
required
Available options:
true