Create Event
Schedules a new event
A status code of 200 does not imply sucessful scheduling, but rather that the request was received successfully.
For reliable scheduling completion info, please use the webhook_url
field in the request to receive a webhook on completion.
Note: Currently the API only supports Calendly event types set to English, German, French and Spanish. Please reach out, if you’d like us to support more languages. We can add more languages if there is a demand.
Watch the video below to learn how to use this endpoint step by step.
Authorizations
API key for authentication. Please purchase a subscription to get your API key.
Body
All fields that should be completed on the scheduling form. This includes not only custom questions but also the default fields required by Calendly (e.g., email address).
Include all fields that are displayed and required to be filled out, as well as any optional fields you intend to complete. If a field is not included, it will not be filled out, and the scheduling process may fail.
URL of the scheduling page. E.g. 'https://calendly.com/johndoe/30min'.
ISO timestamp of the start time. E.g. '2021-01-01T09:15:00Z' OR '2021-01-01T10:15:00+01:00'. DO NOT include millie seconds. NOT: '2021-01-01T10:15:00.000Z'
(Optional) Invitee time zone in IANA format (E.g. 'America/New_York'). This field does not affect the start date of the event start_time
. It is only displayed in Calendly as the invitees local time zone while scheduling the event. Defaults to UTC
.
(Optional) Metadata to be sent to the webhook. This can be used to identify the scheduling request in the webhook. Unstructured data is allowed.
(Optional) URL to send a webhook to after scheduling has completed. If error
is null
scheduling was successful. If error
is not null
scheduling failed.