Create event

Create an event for a given scheduling link.

Note about time slots: You'll only be able to create events that match an available time slot for the underlying scheduling link. You can use the List Available Slots endpoint to query for time slots.

Note about conferencing: For some conferencing providers (like Zoom), the meeting information is not guaranteed to appear in the response body. If our initial attempt to create the meeting room fails, we will retry and attach the information to event later.

Authorization

AuthorizationBearer <token>

OAuth 2.0 authorization code flow

In: header

Path Parameters

link_id*string

Scheduling link ID

Request Body

application/json

Event details

TypeScript Definitions

Use the request body type in TypeScript.

Request body for creating an event.

display_name*string

The scheduler's full name.

email*string

The scheduler's email address.

Formatemail

end_at*string

The ISO-8601 timestamp when the event ends.

Formatdate-time

fields?array<>

The scheduler's answers to the scheduling link's custom fields. Get the fields from the Get Scheduling Link endpoint.

Answer short_text, long_text, url, and hidden fields with value. Answer checkboxes, radios, and select fields with options, picked from the field's options. To select one option, you can instead put that option's exact text in value.

metadata?

An object containing custom metadata attached to the event.

phone_number?|

The scheduler's phone number, formatted like +15555555555 (optional unless "Always gather phone number" is enabled in the scheduling link settings).

start_at*string

The ISO-8601 timestamp when the event starts.

Formatdate-time

time_zone*string

The scheduler's local Olson time zone.

Response Body

`application/json`

curl -X POST "https://example.com/v1/links/link_01J5KC2G3MHPCECSQ6KM6FMDPC/events" \  -H "Content-Type: application/json" \  -d '{    "display_name": "Jane Smith",    "email": "jane@example.com",    "end_at": "2024-01-20T14:30:00Z",    "fields": [      {        "id": "field_123",        "label": "Company",        "type": "short_text",        "value": "Example Corp"      },      {        "id": "field_456",        "label": "Company size",        "options": [          {            "id": "opt_abc",            "value": "1-10"          }        ],        "type": "select"      }    ],    "metadata": {      "project_type": "Web Application",      "source": "website"    },    "phone_number": "+15555555555",    "start_at": "2024-01-20T14:00:00Z",    "time_zone": "America/New_York"  }'

{  "canceled_at": null,  "rescheduled_at": null,  "location_settings": [    {      "integration_id": "zoom_123",      "type": "zoom"    }  ],  "description_settings": {    "include_attendees": true,    "include_fields": false,    "include_link_name": true  },  "location": "Zoom meeting",  "buffer_before": 15,  "additional_info": "Please prepare project overview",  "duration": 30,  "uuid": "550e8400-e29b-41d4-a716-446655440000",  "reschedule_reason": null,  "conferencing": {    "instructions": "Click the link to join",    "join_url": "https://zoom.us/j/123456789",    "meeting_id": "123456789",    "type": "zoom"  },  "link": {    "id": "link_01J5KC2G3MHPCECSQ6KM6FMDPC",    "name": "30 Minute Meeting",    "slug": "30min"  },  "poll": null,  "summary": "30 Minute Meeting with John Doe",  "original_end_at": null,  "description": "Discussing project requirements",  "id": "event_01KKGY70MFPCECSQ6KM6FMDPC3",  "cancel_reason": null,  "organizer": {    "display_name": "John Doe",    "email": "john@example.com",    "fields": [],    "first_name": "John",    "id": "attendee_01J5KCPP3XKRFGT8V2WD9Y8H6X",    "is_organizer": true,    "last_name": "Doe",    "marketing_opt_in": false,    "phone_number": null,    "response_status": "accepted",    "time_zone": "America/New_York"  },  "is_group_session": false,  "original_start_at": null,  "start_at": "2024-01-20T14:00:00Z",  "url": "https://savvycal.com/events/event_01KKGY70MFPCECSQ6KM6FMDPC3",  "payment": {    "amount_total": 1000,    "state": "paid",    "url": "https://dashboard.stripe.com/acct_XYZ/payments/xxxxxxxxx"  },  "maximum_group_size": 1,  "end_at": "2024-01-20T14:30:00Z",  "state": "confirmed",  "attendees": [    {      "display_name": "John Doe",      "email": "john@example.com",      "fields": [],      "first_name": "John",      "id": "attendee_01J5KCPP3XKRFGT8V2WD9Y8H6X",      "is_organizer": true,      "last_name": "Doe",      "marketing_opt_in": false,      "phone_number": null,      "response_status": "accepted",      "time_zone": "America/New_York"    },    {      "display_name": "Jane Smith",      "email": "jane@example.com",      "fields": [],      "first_name": "Jane",      "id": "attendee_01J5KCRR5ZKRFGT8V2WD9Y8H6X",      "is_organizer": false,      "last_name": "Smith",      "marketing_opt_in": true,      "phone_number": "+1234567890",      "response_status": "accepted",      "time_zone": "America/New_York"    }  ],  "scheduler": {    "display_name": "Jane Smith",    "email": "jane@example.com",    "fields": [],    "first_name": "Jane",    "id": "attendee_01J5KCRR5ZKRFGT8V2WD9Y8H6X",    "is_organizer": false,    "last_name": "Smith",    "marketing_opt_in": true,    "phone_number": "+1234567890",    "response_status": "accepted",    "time_zone": "America/New_York"  },  "scope": {    "id": "scope_01J5KC4R7NHQFGT8V2WD9Y8H6X",    "name": "Sales Team",    "slug": "sales"  },  "buffer_after": 0,  "metadata": {},  "created_at": "2024-01-15T10:30:00Z"}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`