Skip to main content
PUT
Update appointment calendar

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Appointment calendar id. Get it from appointmentCalendars.list.

Pattern: ^\d+$

Body

application/json
name
string
required

Calendar name.

Required string length: 1 - 255
active
boolean
required

Whether the calendar accepts new bookings.

timezone
string
required

IANA timezone used to interpret availability and reminders.

Minimum string length: 1
durationMinutes
integer
required

Length of each appointment slot, in minutes.

Required range: -9007199254740991 <= x <= 9007199254740991
bufferAfterMinutes
integer | null
required

Buffer time added after each appointment, in minutes, or null for none.

Required range: -9007199254740991 <= x <= 9007199254740991
locationType
enum<string>
required

Where the appointment takes place, e.g. in-person or video call.

Available options:
inPerson,
phoneCall,
onlineMeeting
scheduleWindowConfig
object
required

How far ahead bookings are allowed (e.g. a rolling window or fixed date range).

maxAppointmentsPerUser
integer | null
required

Maximum number of active appointments a single contact may hold, or null for unlimited.

Required range: 1 <= x <= 9007199254740991
dailyLimitEnabled
boolean
required

Whether maxPerDay is enforced.

maxPerDay
integer | null
required

Maximum bookings per day when dailyLimitEnabled is true, or null when not set.

Required range: 1 <= x <= 9007199254740991
allowGroupMeeting
boolean
required

Whether multiple contacts can book the same slot.

maxPerSlot
integer | null
required

Maximum bookings per slot when allowGroupMeeting is true, or null for unlimited.

Required range: 1 <= x <= 9007199254740991
externalEventTitleTemplate
string | null
required

Template for the external calendar event's title, or null to use the default.

Maximum string length: 1024
externalEventDescriptionTemplate
string | null
required

Template for the external calendar event's description, or null to use the default.

Maximum string length: 8192
externalEventAttendeesTemplate
string | null
required

Template for the external calendar event's attendee list, or null to use the default.

Maximum string length: 8192
availability
object[]
required

Weekly recurring availability intervals.

Maximum array length: 70
reminders
object[]
required

Reminder flows to trigger before each appointment.

Maximum array length: 50
description
string | null

Optional internal description of the calendar.

Maximum string length: 2000
locationDetail
string | null

Address or link shown to the invitee for this location type.

Maximum string length: 500
confirmationMessage
string | null

Message shown to the invitee after booking.

Maximum string length: 2000
confirmationFlowId
string | null

Flow to trigger when an appointment is booked, or null for none.

Pattern: ^\d+$
cancellationFlowId
string | null

Flow to trigger when an appointment is cancelled, or null for none.

Pattern: ^\d+$
externalConnectionId
string | null

External calendar connection (from appointmentExternalCalendars.list) to sync bookings to, or null for none.

Pattern: ^\d+$

Response

OK

The response is of type any.