Skip to main content
Calendar EventsVersion: v3

Create Block Slot

POST/calendars/events/block-slots

Create block slot

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars/events.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Body

application/json
titlestring

Title

Example:Test Event
calendarIdstringrequired

Either calendarId or assignedUserId can be set, not both. Event (class) calendars only. To block time on any other calendar type, leave calendarId out and set assignedUserId to the host's user id: that blocks the host on every calendar they host.

Example:CVokAlI8fgw4WYWoCtQz
assignedUserIdstring

Either calendarId or assignedUserId can be set, not both. The user whose time is blocked. Use this, not calendarId, for personal, round robin and collective calendars.

Example:CVokAlI8fgw4WYWoCtQz
locationIdstringrequired

Location Id

Example:C2QujeCh8ZnC7al2InWR
startTimestring

Start Time. ISO 8601 with the UTC offset, e.g. 2026-11-09T14:00:00+05:30. A time without an offset is read as UTC.

Example:2021-06-23T03:30:00+05:30
endTimestring

End Time. ISO 8601 with the UTC offset, e.g. 2026-11-09T14:00:00+05:30. A time without an offset is read as UTC.

Example:2021-06-23T04:30:00+05:30

Response

application/json

Successful response

idstringrequired

Id

Example:0TkCdp9PfvLeWKYRRvIz
locationIdstringrequired

Location Id

Example:C2QujeCh8ZnC7al2InWR
titlestringrequired

Title

Example:My event
startTimeobjectrequired

Start Time

Example:2021-06-23T03:30:00+05:30
endTimeobjectrequired

End Time

Example:2021-06-23T04:30:00+05:30
calendarIdstring

Calendar id

Example:CVokAlI8fgw4WYWoCtQz
assignedUserIdstring

Assigned User Id

Example:0007BWpSzSwfiuSl0tR2