Skip to main content
POST
Cancel a booking

Authorizations

Authorization
string
header
required

Use the Authorization header with Bearer scheme.

Examples:

  • API Key: Authorization: Bearer calid_xxxxx

Path Parameters

id
integer
required

Numeric booking identifier.

Required range: x > 1
Example:

101

Body

application/json

Optional controls for cancellation scope, seated-event seat cancellation, and payment refund handling.

Optional controls for cancellation scope, seated-event seat cancellation, and payment refund handling.

allRemainingBookings
boolean

When true, cancels all remaining future bookings in the recurring series from now onward.

Example:

false

cancellationReason
string
default:Not Provided

Optional reason stored on cancelled booking records and used in cancellation notifications.

Example:

"Rescheduling required"

seatReferenceUid
string

Optional seat reference UID for cancelling a specific attendee seat in seated event types.

Example:

"seat_123"

cancelledBy
string<email>

Optional actor email recorded as the canceller (cancelledBy) on the booking.

Example:

"owner@example.com"

autoRefund
boolean
default:false

When true, attempts payment cancellation/refund for paid bookings and marks booking payment metadata as refunded.

Example:

false

Response

Booking cancelled

Booking cancelled

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