{your-workspace}
with your workspace’s subdomain. Learn how to find your subdomain in Identifying your 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 thetemplate_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.
Headers
X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.
Body
Slug of the scheduling link. This value should be unique.
"meeting-with-oliver-smith"
Name of the scheduling link.
"Meeting with Oliver Smith"
Emails of the hosts of scheduling link in array format.
["oliver@example.com", "jane@example.com"]
Duration of the scheduling link in minutes.
30
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.
"cc98d282-4cf6-414d-ba58-53fa94b9bca3"
Description of the scheduling link.
"Discuss project updates"
Kind of scheduling link.
one_on_one
, round_robin
, multihost
, grouped
Start time increment for the scheduling link in minutes. Defaults to 30.
30
Whether users can select from multiple meeting duration options.
false
Whether users can select from multiple meeting platforms/locations.
false
Phone number for the meeting when spot is set to phone_call.
"+1-555-0123"
Custom meeting instructions or details when spot is set to custom.
"Custom meeting instructions"
Physical location details when spot is set to in_person.
"123 Main St, Suite 100"
Array of duration options when multiple durations are allowed.
Array of spot options when multiple spots are allowed.