Cancel Appointment

POST/api/v1/calendar/appointments/cancel

Cancels a previously scheduled appointment. Requires the appointment ID and invitee email. An optional cancellation reason can be provided.

cv-api-keyRate Limited

Productionhttps://api.care360-next.carevalidate.com/api/v1/calendar/appointments/cancel

Staginghttps://api-staging.care360-next.carevalidate.com/api/v1/calendar/appointments/cancel

Parameters

Headers

cv-api-keystringrequired

API key for authentication

Request Body

emailstringrequired

Invitee email address associated with the appointment.

Example: invitee@example.com

appointmentIdstringrequired

Unique identifier of the appointment to cancel.

Example: 23ddc211-2a42-4d65-9091-9d9170d0ed62

reasonstringoptional

Optional text describing the reason for cancellation.

Example: Testing cancel event

Examples

cURL

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

JavaScript

const response = await fetch("https://api.example.com/api/v1/calendar/appointments/cancel", {
method: "POST",
headers: {
  "Content-Type": "application/json",
  "cv-api-key": "your-org-cv-api-key",
},
body: JSON.stringify({
  email: "invitee@example.com",
  appointmentId: "23ddc211-2a42-4d65-9091-9d9170d0ed62",
  reason: "Testing cancel event",
}),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.post(
  "https://api.example.com/api/v1/calendar/appointments/cancel",
  headers={
      "Content-Type": "application/json",
      "cv-api-key": "your-org-cv-api-key",
  },
  json={
      "email": "invitee@example.com",
      "appointmentId": "23ddc211-2a42-4d65-9091-9d9170d0ed62",
      "reason": "Testing cancel event",
  },
)

print(response.json())

Try It Out

Try itAPI Playground

▶

Responses

▶200SuccessAppointment cancelled successfully.

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

▶400Bad RequestReturned when the request body is invalid, required fields are missing, or fields fail validation.

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

▶401UnauthorizedReturned when API key is missing or invalid.

{
  "status": 401,
  "success": false,
  "message": "Unauthorized"
}

▶429Too Many RequestsReturned when rate limit is exceeded.

{
  "status": 429,
  "success": false,
  "message": "Rate limit exceeded"
}