Skip to main content
POST
Reserve a slot

Headers

cal-api-version
string
default:2024-09-04
required

Must be set to 2024-09-04. If not set to this value, the endpoint will default to an older version.

Example:

"2024-09-04"

Authorization
string

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

x-cal-client-id
string

For platform customers - OAuth client ID

Body

application/json
eventTypeId
number
required

The ID of the event type for which slot should be reserved.

Example:

1

slotStart
string<date-time>
required

ISO 8601 datestring in UTC timezone representing available slot.

Example:

"2024-09-04T09:00:00Z"

slotDuration
number

By default slot duration is equal to event type length, but if you want to reserve a slot for an event type that has a variable length you can specify it here as a number in minutes. If you don't have this set explicitly that event type can have one of many lengths you can omit this.

Example:

30

reservationDuration
number

ONLY for authenticated requests with api key, access token or OAuth credentials (ID + secret).

Example:

5

Response

201 - application/json
status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
object
required