POST
/
api
/
scheduled_events

Authorizations

X-API-Key
string
headerrequired

API key for authentication. Please reach out to us to get your API key.

Body

application/json
scheduling_url
string
required

URL of the scheduling page. E.g. 'https://calendly.com/johndoe/30min'.

start_time
string
required

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'

fields
object[]
required

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.

invitee_timezone
string

(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.

webhook_url
string

(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.

Response

200 - application/json
message
string
required
Introduction