Create appointment

POST 
/calendars/events/appointments

Create appointment

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

titlestring

Title

meetingLocationTypestring
Meeting location type.
• If address is provided in the request body, the meetingLocationType defaults to custom.
Available optionscustomzoomgmeetphoneaddressms_teamsgoogle
meetingLocationIdstring
The unique identifier for the meeting location.
• This value can be found in calendar.locationConfigurationsor calendar.teamMembers[].locationConfigurations
Default value: default
overrideLocationConfigboolean
Flag to override location config
• false - If only meetingLocationId is provided
• true - If only meetingLocationType is provided
appointmentStatusstring
Appointment status
Available optionsnewconfirmedcancelledshowednoshowinvalidcompletedactive
assignedUserIdstring

Assigned User Id

descriptionstring

Appointment Description

addressstring

Appointment Address

ignoreDateRangeboolean

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

toNotifyboolean
If set to false, the automations will not run. Defaults to true
Default value: true
ignoreFreeSlotValidationboolean

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

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.

calendarIdstringrequired

Calendar Id

locationIdstringrequired

Location Id

contactIdstringrequired

Contact Id

startTimestringrequired

Start Time

endTimestring

End Time

Example (auto)

{
  "title": "Test Event",
  "meetingLocationType": "custom",
  "meetingLocationId": "custom_0",
  "overrideLocationConfig": true,
  "appointmentStatus": "confirmed",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "description": "Booking a call to discuss the project",
  "address": "Zoom",
  "ignoreDateRange": false,
  "toNotify": false,
  "ignoreFreeSlotValidation": true,
  "rrule": "RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5",
  "calendarId": "CVokAlI8fgw4WYWoCtQz",
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "contactId": "0007BWpSzSwfiuSl0tR2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30"
}

application/json

Successful response

application/json

Schema

Schema

calendarIdstringrequired

Calendar Id

locationIdstringrequired

Location Id

contactIdstringrequired

Contact Id

startTimestring

Start Time

endTimestring

End Time

titlestring

Title

meetingLocationTypestring
Meeting Location Type
Default value: default
appointmentStatusstring
Appointment status
Available optionsnewconfirmedcancelledshowednoshowinvalidactivecompleted
assignedUserIdstring

Assigned User Id

addressstring

Appointment Address

isRecurringboolean

true if the event is recurring otherwise false

rrulestring

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

dateAddedstringrequired

Date Added

dateUpdatedstringrequired

Date Updated

idstringrequired

Id

Example (auto)

{
  "calendarId": "CVokAlI8fgw4WYWoCtQz",
  "locationId": "C2QujeCh8ZnC7al2InWR",
  "contactId": "0007BWpSzSwfiuSl0tR2",
  "startTime": "2021-06-23T03:30:00+05:30",
  "endTime": "2021-06-23T04:30:00+05:30",
  "title": "Test Event",
  "meetingLocationType": "custom",
  "appointmentStatus": "confirmed",
  "assignedUserId": "0007BWpSzSwfiuSl0tR2",
  "address": "Zoom",
  "isRecurring": "true",
  "rrule": "RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5",
  "dateAdded": "2021-06-23T03:30:00+05:30",
  "dateUpdated": "2021-06-23T04:30:00+05:30",
  "id": "0TkCdp9PfvLeWKYRRvIz"
}