POST

Create Calendar

Creates a new booking calendar in the specified sub-account.

POSThttps://api.vantaxai.com/v1/calendars

Only `name` and `sub_account_id` are required. `slot_duration_minutes` defaults to 30 and is clamped to the 5–480 minute range; `is_active` defaults to true.

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

Body Parameters

namestringrequired
Display name of the calendar.
example: Front Desk Bookings
sub_account_idstringrequired
Sub-account that will own the calendar.
example: sub_8a1f4c2e
descriptionstringoptional
Internal description of the calendar's purpose.
colorstringoptional
Hex color used to label the calendar in the UI.
example: #2563eb
is_activebooleanoptional
Whether the calendar accepts bookings. Defaults to true.
slot_duration_minutesintegeroptional
Length of each bookable slot, in minutes (5–480). Defaults to 30.
example: 30

Request

curl -X POST https://api.vantaxai.com/v1/calendars \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Front Desk Bookings",
    "sub_account_id": "sub_8a1f4c2e",
    "color": "#2563eb",
    "slot_duration_minutes": 30
  }'

const res = await fetch("https://api.vantaxai.com/v1/calendars", {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Front Desk Bookings",
    sub_account_id: "sub_8a1f4c2e",
    color: "#2563eb",
    slot_duration_minutes: 30,
  }),
});
const { data: calendar } = await res.json();

const calendar = await vantax.calendars.create({
  name: "Front Desk Bookings",
  subAccountId: "sub_8a1f4c2e",
  color: "#2563eb",
  slotDurationMinutes: 30,
});

calendar = vantax.calendars.create(
    name="Front Desk Bookings",
    sub_account_id="sub_8a1f4c2e",
    color="#2563eb",
    slot_duration_minutes=30,
)

Response

{
  "success": true,
  "message": "Calendar created successfully",
  "data": {
    "id": "cal_22f9",
    "name": "Front Desk Bookings",
    "description": null,
    "color": "#2563eb",
    "is_active": true,
    "slot_duration_minutes": 30,
    "sub_account_id": "sub_8a1f4c2e",
    "created_at": "2026-01-14T10:30:00Z"
  }
}

{
  "success": false,
  "message": "Validation failed",
  "errors": [
    { "field": "name", "message": "name is required" }
  ]
}