Skip to main content
Calendar EventsVersion: v3

Create appointment

POST/calendars/events/appointments

Create appointment

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
meetingLocationTypestring

Meeting location type.

  • If address is provided in the request body, the meetingLocationType defaults to custom.
Available optionscustomzoomgmeetphoneaddressms_teamsgoogle
Example:custom
meetingLocationIdstring

The unique identifier for the meeting location.

  • This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
Default:default
Example:custom_0
overrideLocationConfigboolean

Flag to override location config

  • false - If only meetingLocationId is provided
  • true - If only meetingLocationType is provided
Example:true
appointmentStatusstring

Appointment status

Available optionsnewconfirmedcancelledshowednoshowinvalidcompletedactive
Example:confirmed
assignedUserIdstring

Assigned User Id

Example:0007BWpSzSwfiuSl0tR2
descriptionstring

Appointment Description

Example:Booking a call to discuss the project
addressstring

Appointment Address

Example:Zoom
ignoreDateRangeboolean

If set to true, the minimum scheduling notice and date range would be ignored

Example:false
toNotifyboolean

If set to false, the automations will not run. Defaults to true

Default:true
Example:false
ignoreFreeSlotValidationboolean

If true the time slot validation would be avoided for any appointment creation (even the ignoreDateRange)

Example:true
rrulestring

RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event. The rrule only be applied if ignoreFreeSlotValidation is true.

Example:RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5
calendarIdstringrequired

Calendar Id

Example:CVokAlI8fgw4WYWoCtQz
locationIdstringrequired

Location Id

Example:C2QujeCh8ZnC7al2InWR
contactIdstringrequired

Contact Id

Example:0007BWpSzSwfiuSl0tR2
startTimestringrequired

Start Time

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

End Time

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

Response

application/json

Successful response

calendarIdstringrequired

Calendar Id

Example:CVokAlI8fgw4WYWoCtQz
locationIdstringrequired

Location Id

Example:C2QujeCh8ZnC7al2InWR
contactIdstringrequired

Contact Id

Example:0007BWpSzSwfiuSl0tR2
startTimestring

Start Time

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

End Time

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

Title

Example:Test Event
meetingLocationTypestring

Meeting Location Type

Default:default
Example:custom
appointmentStatusstring

Appointment status

Available optionsnewconfirmedcancelledshowednoshowinvalidactivecompleted
Example:confirmed
assignedUserIdstring

Assigned User Id

Example:0007BWpSzSwfiuSl0tR2
addressstring

Appointment Address

Example:Zoom
isRecurringboolean

true if the event is recurring otherwise false

Example:true
rrulestring

RRULE as per the iCalendar (RFC 5545) specification for recurring events

Example:RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5
dateAddedstringrequired

Date Added

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

Date Updated

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

Id

Example:0TkCdp9PfvLeWKYRRvIz