Skip to main content
POST
Create a scheduling link
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Creating from scratch

Provide all the required configuration values directly in your request.

Creating from a template

To create a scheduling link from an existing template, include the template_id field in your request. When a template is used:
  • All template configuration values are automatically copied.
  • Values you provide in the same request override the template values.
Note: You can find available template IDs using the List scheduling link templates endpoint. Example with template:

Headers

X-Api-Key
string
required

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

Body

application/json
slug
string
required

Slug of the scheduling link. This value should be unique.

Example:

"meeting-with-oliver-smith"

name
string
required

Name of the scheduling link.

Example:

"Meeting with Oliver Smith"

hosts
string[]
required

Emails of the hosts of scheduling link in array format.

Example:
duration
integer
required

Duration of the scheduling link in minutes.

Example:

30

template_id
string

ID of an existing meeting template to use as a base. When provided, all template values will be copied to the new scheduling link. Values passed in the same request will override template values.

Example:

"cc98d282-4cf6-414d-ba58-53fa94b9bca3"

description
string

Description of the scheduling link.

Example:

"Discuss project updates"

kind
enum<string>
default:one_on_one

Kind of scheduling link.

Available options:
one_on_one,
round_robin,
multihost,
grouped
start_time_increment
integer

Start time increment for the scheduling link in minutes. Defaults to 30.

Example:

30

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

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

is_multiple_durations_allowed
boolean

Whether users can select from multiple meeting duration options.

Example:

false

is_multiple_spots_allowed
boolean

Whether users can select from multiple meeting platforms/locations.

Example:

false

spot_phone_call_number
string

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

Example:

"+1-555-0123"

spot_custom_text
string

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

Example:

"Custom meeting instructions"

spot_in_person_location
string

Physical location details when meeting place is set to in_person.

Example:

"123 Main St, Suite 100"

locked_time_zone
string

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"

durations
object[]

Array of duration options when multiple durations are allowed.

spots
object[]

Array of place options when multiple places are allowed.

Response

201 - application/json

Created - Resource created successfully

message
string
Example:

"Meeting created successfully"

meeting
object