Cancel Appointment

Endpoint

POST /api/v1/calendar/appointments/cancel

Description

Cancels a previously scheduled calendar appointment for an invitee. This endpoint requires the appointment identifier, invitee email and may include an optional reason for cancellation.

Authentication

This endpoint requires API key authentication via the cv-api-key header.

Headers

Header Name	Type	Required	Description
cv-api-key	string	Yes	API key for authentication

Request Body

Body Fields

Field	Type	Required	Description
email	string	Yes	Invitee email address associated with the appointment.
appointmentId	string	Yes	Unique identifier of the appointment to cancel.
reason	string	No	Optional text describing the reason for cancellation.

Request Example

curl --location "https://api.example.com/api/v1/calendar/appointments/cancel" \
  --header "cv-api-key: your-org-cv-api-key" \
  --data-raw '{
    "email": "invitee@example.com",
    "appointmentId": "23ddc211-2a42-4d65-9091-9d9170d0ed62",
    "reason": "Testing cancel event"
  }'

Rate Limiting

This endpoint is protected by rate limiting middleware. Excessive requests may result in rate limit errors.

Success Response

Status Code

200 OK

Response Body

{
  "status": 200,
  "success": true,
  "message": "Meeting schedule successfully"
}

Response Fields

Field	Type	Description
status	number	HTTP status code (200).
success	boolean	Indicates successful request (true).
message	string	Success message.

Error Responses

400 Bad Request

Returned when:

• Invalid request body is provided
• Required fields are missing
• Fields fail validation

Response Body

{
  "status": 400,
  "success": false,
  "message": "Invalid request",
  "error": "Error message describing the validation failure"
}

401 Unauthorized

Returned when API key is missing or invalid.

429 Too Many Requests

Returned when rate limit is exceeded.