Update scheduling-link availability

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

meeting_sid

string

required

The unique SID of the scheduling link you want to fetch. You can get sid in different ways. Visit the scheduling link page and then click on "Settings" > "Show SID". That will give you sid. The other way you can get sid is by listing scheduling links using our List scheduling links API. Here you will see sid for each scheduling link.

Body

application/json

periods

object[]

Hide child attributes

periods.wday

string

The weekday (e.g., "monday", "tuesday", etc.).

periods.start_time

string

Start time in "HH:MM AM/PM" format.

periods.end_time

string

End time in "HH:MM AM/PM" format.

Example:

[
  {
    "wday": "monday",
    "start_time": "09:00 AM",
    "end_time": "05:00 PM"
  },
  {
    "wday": "tuesday",
    "start_time": "11:00 AM",
    "end_time": "04:00 PM"
  }
]

time_zone

string

Optional IANA timezone name (e.g., "America/New_York", "Asia/Kolkata"). When provided, the start_time and end_time values in periods are assumed to be in this timezone and will be converted to the user's timezone before saving. If not provided, times are assumed to be in the user's timezone.

Example:

"America/New_York"

Response

200 - application/json

OK - Meeting updated successfully

message

string

meeting

object

Hide child attributes

meeting.id

string

Unique identifier for the scheduling link.

meeting.sid

string

Short identifier (SID) for the meeting, used in URLs and API calls.

meeting.name

string

Display name of the scheduling link.

meeting.slug

string

URL-friendly identifier for the meeting, used in public scheduling links.

meeting.description

string

Detailed description of the meeting purpose or agenda.

meeting.kind

enum<string>

Type of meeting. one_on_one for individual meetings, round_robin for rotating hosts, multihost for multiple simultaneous hosts, grouped for group sessions.

Available options:

one_on_one,

round_robin,

multihost,

grouped

meeting.duration

integer

Duration of the meeting in minutes.

meeting.disabled

boolean

Whether the scheduling link is currently disabled and not accepting bookings.

meeting.spot

enum<string>

Meeting platform or location type for the scheduled meeting.

Available options:

custom,

jitsi,

google_meet,

daily,

zoom,

whereby,

teams,

phone_call,

in_person

meeting.spot_in_person_location

string | null

Physical location details when meeting place is set to in_person.

meeting.spot_custom_text

string | null

Custom meeting instructions or details when meeting place is set to custom.

meeting.spot_phone_call_number

string | null

Phone number for the meeting when place is set to phone_call.

meeting.is_template

boolean

Whether this meeting is a template that can be used to create other meetings.

meeting.schedulable_range_type

enum<string>

How the scheduling range is calculated - by days into future, business days, or specific date range.

Available options:

number_of_days_into_the_future,

number_of_business_days_into_the_future,

date_range

meeting.schedulable_range_value

string

Value for the scheduling range (e.g., number of days or date range).

meeting.lead_time

integer

Minimum advance notice required for booking in minutes.

meeting.start_time_increment

integer

Time increment in minutes for available booking slots (e.g., 30 for 30-minute slots).

meeting.before_buffer_time

integer

Buffer time in minutes before each meeting to allow for setup, preparation, or travel time. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

meeting.after_buffer_time

integer

Buffer time in minutes after each meeting to allow for wrap-up, notes, or preparation for the next meeting. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

meeting.created_at

string

Timestamp when the meeting was created.

Example:

"2025-12-23T05:05:27.037Z"

meeting.updated_at

string

Timestamp when the meeting was last updated.

Example:

"2025-03-31T13:22:19.832Z"

meeting.deleted_at

string | null

Timestamp when the meeting was deleted (soft delete).

Example:

null

meeting.is_multiple_spots_allowed

boolean

Whether users can select from multiple meeting places.

meeting.is_multiple_durations_allowed

boolean

Whether users can select from multiple meeting duration options.

meeting.conditional_pricing_enabled

boolean

Whether conditional pricing rules are applied to this meeting.

meeting.is_email_reminders_enabled

boolean

Whether email reminders are sent for this meeting.

meeting.is_sms_reminders_enabled

boolean

Whether SMS reminders are sent for this meeting.

meeting.organization_id

string

Unique identifier of the organization that owns this meeting.

meeting.rescheduling_lead_time

integer

Minimum advance notice required for rescheduling in minutes.

meeting.cancellation_lead_time

integer

Minimum advance notice required for cancellation in minutes.

meeting.booking_modification_allowed

boolean

Whether users are allowed to modify their bookings after creation.

meeting.cancellation_too_late_notice

string | null

Custom message shown when cancellation is attempted too late.

meeting.cancellation_policy

string | null

Policy text explaining cancellation terms and conditions.

meeting.rescheduling_too_late_notice

string | null

Custom message shown when rescheduling is attempted too late.

meeting.pre_booking_allowed

boolean

Whether users can book meetings in advance beyond the normal scheduling range.

meeting.original_price_enabled

boolean

Whether to show the original price alongside any discounted price.

meeting.original_price

number | null

Original price of the meeting before any discounts.

meeting.locked_time_zone

string | null

Time zone to lock the scheduling link to. When set, all available times are displayed in this time zone regardless of the booker's location. Must be a valid IANA time zone identifier (e.g., 'America/New_York', 'Europe/London').

Example:

"America/New_York"

meeting.fees

object[]

Additional fees or charges associated with the meeting.

meeting.durations_possible

integer[]

List of available duration options in minutes when multiple durations are allowed.

meeting.durations

object[]

Hide child attributes

meeting.durations.id

string

Unique identifier for the duration option.

Example:

"4ece6b6b-4b5f-4c15-9122-a85af189198c"

meeting.durations.duration

integer

Duration in minutes.

Example:

30

meeting.durations.is_default

boolean

Whether this duration is the default option.

Example:

false

meeting.durations.created_at

string<date-time>

Timestamp when the duration option was created.

Example:

"2025-08-18T07:43:16.775Z"

meeting.durations.updated_at

string<date-time>

Timestamp when the duration option was last updated.

Example:

"2025-08-18T08:03:58.019Z"

meeting.hosts

object[]

List of hosts for the scheduling link with their name and email.

Hide child attributes

meeting.hosts.name

string

Full name of the host.

Example:

"Oliver Smith"

meeting.hosts.email

string

Email address of the host.

Example:

"oliver@example.com"

meeting.spots

object[]

Hide child attributes

meeting.spots.id

string

Unique identifier for the meeting place option.

Example:

"bcc90342-9345-4d89-9144-d25d7c7b3521"

meeting.spots.spot

enum<string>

The place type for the meeting.

Available options:

daily,

zoom,

jitsi,

google_meet,

teams,

whereby,

in_person,

custom,

phone_call

Example:

"jitsi"

meeting.spots.is_default

boolean

Whether this meeting place is the default option.

Example:

false

meeting.spots.phone_call_number

string | null

Phone number for phone call meeting place. Only populated when place type is "phone_call", otherwise null.

Example:

null

meeting.spots.in_person_location

string | null

Location details for in-person meetings. Only populated when place type is "in_person", otherwise null.

Example:

null

meeting.spots.custom_text

string | null

Custom text for custom meeting place. Only populated when place type is "custom", otherwise null.

Example:

null

meeting.spots.created_at

string<date-time>

Timestamp when the meeting place option was created.

Example:

"2025-08-18T07:19:28.341Z"

meeting.spots.updated_at

string<date-time>

Timestamp when the meeting place option was last updated.

Example:

"2025-08-18T07:35:32.822Z"

Getting Started

Scheduling links

Meeting places

Meeting durations

Bookings

Availabilities

Slots

Packages

Team Members

Meeting Outcomes

Discount Codes

Automation Rules

API v1 (Deprecated)

Update scheduling-link availability

Headers

Path Parameters

Body

Response

Getting Started

Scheduling links

Meeting places

Meeting durations

Bookings

Availabilities

Slots

Packages

Team Members

Meeting Outcomes

Discount Codes

Automation Rules

API v1 (Deprecated)

Documentation Index

Headers

Path Parameters

Body

Response