Cancel Booking
POST
/v1/bookings/{uid}/cancelThe Cancel Booking API allows users to cancel an existing booking. By providing the booking uid, the API will update the booking status to “Cancelled”. This action may trigger notifications or other processes depending on the system’s configuration.
Request
{}
Request samples
Responses
Unique identifier for this booking
EventTypeId associated with this event
Booking name
Booking description
Booking status
The time that event was scheduled to start in UTC time (e.g. "2024-03-01T20:00:00.000Z").
The time that event was scheduled to end in UTC time (e.g. "2024-03-01T21:00:00.000Z").
Location type. like zoom, google meet, etc.
online meeting url
phone number
location address
custom location name
access information
guest selected Timezone
Booking priority
Booking cancel reason
Booking cancelled time
Booking canceller
The time this booking was created
The time this booking was updated
{
"data": {
"uid": "string",
"eventTypeId": "string",
"name": "string",
"description": "string",
"status": "request",
"startedAt": "2019-08-24T14:15:22.123Z",
"endedAt": "2019-08-24T14:15:22.123Z",
"locationId": "inPerson",
"url": "string",
"phoneNumber": "string",
"address": "string",
"customLocation": "string",
"access": "string",
"timeZone": "string",
"priority": "low",
"cancelReason": "string",
"cancelledAt": "2019-08-24T14:15:22.123Z",
"cancelledBy": "host",
"hosts": [
{
"userId": "string",
"role": "admin"
}
],
"createdAt": "2019-08-24T14:15:22.123Z",
"updatedAt": "2019-08-24T14:15:22.123Z"
}
}