PATCH

Update Calendar

Updates one or more fields on an existing calendar.

PATCHhttps://api.vantaxai.com/v1/calendars/{calendar_id}

Only include the fields you want to change. `slot_duration_minutes` is clamped to the 5–480 minute range.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

calendar_idstringrequired
The calendar to update.
example: cal_22f9

Body Parameters

namestringoptional
New display name.
descriptionstringoptional
Updated description.
colorstringoptional
New hex label color.
example: #16a34a
is_activebooleanoptional
Enable or disable bookings on the calendar.
slot_duration_minutesintegeroptional
New slot length in minutes (5–480).
example: 45

Request

curl -X PATCH https://api.vantaxai.com/v1/calendars/cal_22f9 \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "color": "#16a34a",
  "is_active": true
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/calendars/cal_22f9",
  {
  method: "PATCH",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "string",
    "description": "string",
    "color": "#16a34a",
    "is_active": true
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// PATCH /v1/calendars/{calendar_id}
const result = await vantax.request("PATCH", "/v1/calendars/{calendar_id}", {
  "name": "string",
  "description": "string",
  "color": "#16a34a",
  "is_active": true
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# PATCH /v1/calendars/{calendar_id}
result = vantax.request("PATCH", "/v1/calendars/{calendar_id}", json={"name": "string", "description": "string", "color": "#16a34a", "is_active": true})

Response

{
  "success": true,
  "message": "Calendar updated successfully",
  "data": {
    "id": "cal_22f9",
    "name": "Front Desk Bookings (Extended)",
    "color": "#16a34a",
    "is_active": true,
    "slot_duration_minutes": 45,
    "sub_account_id": "sub_8a1f4c2e",
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "slot_duration_minutes", "message": "slot_duration_minutes must be between 5 and 480" }
  ]
}

{ "success": false, "message": "Calendar not found" }