Create Calendar

POST 
/calendars/

Create calendar in a location.

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

isActiveboolean
Should the created calendar be active or draft
Default value: true
notificationsobject[]deprecated

🚨 Deprecated! Please use 'Calendar Notifications APIs' instead.

locationIdstringrequired

Location ID

groupIdstring

Group Id

teamMembersobject[]

Team members are required for calendars of type: Round Robin, Collective, Class, Service. Personal calendar must have exactly one team member.

eventTypestring
Event type for round robin distribution
Available optionsRoundRobin_OptimizeForAvailabilityRoundRobin_OptimizeForEqualDistribution
namestringrequired

Calendar name

descriptionstring

Calendar description

slugstring

Calendar slug for URL

widgetSlugstring

Widget slug

calendarTypestring
Calendar type
Available optionsround_robineventclass_bookingcollectiveservice_bookingpersonal
widgetTypestring
Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout.
Available optionsdefaultclassic
eventTitlestring
Title for calendar events
Default value: {{contact.name}}
eventColorstring
Color for calendar events in hex format
Default value: #039be5
locationConfigurationsobject[]

Meeting location configuration for event calendar

slotDurationnumber
This controls the duration of the meeting
Default value: 30
slotDurationUnitstring
Unit for slot duration.
Available optionsminshours
slotIntervalnumber
Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
Default value: 30
slotIntervalUnitstring
Unit for slot interval.
Available optionsminshours
slotBuffernumber

Slot-Buffer is additional time that can be added after an appointment, allowing for extra time to wrap up

slotBufferUnitstring
Unit for slot buffer.
Available optionsminshours
preBuffernumber

Pre-Buffer is additional time that can be added before an appointment, allowing for extra time to get ready

preBufferUnitstring
Unit for pre-buffer.
Available optionsminshours
appoinmentPerSlotnumber
Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.
Default value: 1
appoinmentPerDaynumber

Number of appointments that can be booked for a given day

allowBookingAfternumber

Minimum scheduling notice for events

allowBookingAfterUnitstring
Unit for minimum scheduling notice
Available optionshoursdaysweeksmonthsmins
allowBookingFornumber

Minimum number of days/weeks/months for which to allow booking events

allowBookingForUnitstring
Unit for controlling the duration for which booking would be allowed for
Available optionsdaysweeksmonths
openHoursobject[]deprecated

While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.

enableRecurringboolean
Enable recurring appointments for the calendars. Please note that only one member should be added in the calendar to enable this
Default value: false
recurringobject

Recurring appointment configuration

formIdstring

Form ID to be used for booking

stickyContactboolean

Enable sticky contact assignment

isLivePaymentModeboolean

Whether payment mode is live

autoConfirmboolean
Auto-confirm appointments
Default value: true
shouldSendAlertEmailsToAssignedMemberboolean

Send alert emails to assigned team member

alertEmailstring

Alert email address

googleInvitationEmailsboolean
Send Google invitation emails
Default value: false
allowRescheduleboolean
Allow rescheduling of appointments
Default value: true
allowCancellationboolean
Allow cancellation of appointments
Default value: true
shouldAssignContactToTeamMemberboolean

Assign contact to team member on booking

shouldSkipAssigningContactForExistingboolean

Skip assigning contact if contact already exists

notesstring

Notes for the calendar

pixelIdstring

Facebook Pixel ID for tracking

formSubmitTypestring
Action after form submission
Available optionsRedirectURLThankYouMessage
formSubmitRedirectURLstring

Redirect URL after form submission

formSubmitThanksMessagestring

Thank you message displayed after form submission

availabilityTypenumberdeprecated
While we will support this property for backward compatibility, it is not required anymore.
Available options01
availabilitiesobject[]deprecated

While we will support this property for backward compatibility, it is recommended to use 'Availability' APIs instead.

guestTypestring
Type of guest allowed
Available optionscount_onlycollect_detail
consentLabelstring

Consent label text

calendarCoverImagestring

Calendar cover image URL

lookBusyConfigobject

Look Busy Configuration

appointmentPerSlotnumber
Maximum bookings per slot (per user). Maximum seats per slot in case of Class Booking Calendar.
Default value: 1
appointmentPerDaynumber

Number of appointments that can be booked for a given day

Example (auto)

{
  "isActive": true,
  "locationId": "ocQHyuzHvysMo5N5VsXc",
  "groupId": "BqTwX8QFwXzpegMve9EQ",
  "teamMembers": [
    {
      "userId": "ocQHyuzHvysMo5N5VsXc",
      "priority": 0.5,
      "isPrimary": true
    }
  ],
  "eventType": "RoundRobin_OptimizeForAvailability",
  "name": "test calendar",
  "description": "this is used for testing",
  "slug": "test1",
  "widgetSlug": "test1",
  "calendarType": "round_robin",
  "widgetType": "classic",
  "eventTitle": "{{contact.name}}",
  "eventColor": "#039BE5",
  "locationConfigurations": [
    {
      "kind": "custom",
      "location": "https://meet.google.com/abc-def"
    }
  ],
  "slotDuration": 30,
  "slotDurationUnit": "mins",
  "slotInterval": 30,
  "slotIntervalUnit": "mins",
  "slotBuffer": 15,
  "slotBufferUnit": "mins",
  "preBuffer": 10,
  "preBufferUnit": "mins",
  "appoinmentPerSlot": 1,
  "appoinmentPerDay": 8,
  "allowBookingAfter": 4,
  "allowBookingAfterUnit": "days",
  "allowBookingFor": 30,
  "allowBookingForUnit": "days",
  "enableRecurring": false,
  "recurring": {
    "freq": "WEEKLY",
    "count": 4,
    "bookingOption": "skip",
    "bookingOverlapDefaultStatus": "confirmed"
  },
  "formId": "YlWd2wuCAZQzh2cH1fVZ",
  "stickyContact": true,
  "isLivePaymentMode": false,
  "autoConfirm": true,
  "shouldSendAlertEmailsToAssignedMember": false,
  "alertEmail": "[email protected]",
  "googleInvitationEmails": true,
  "allowReschedule": true,
  "allowCancellation": true,
  "shouldAssignContactToTeamMember": true,
  "shouldSkipAssigningContactForExisting": false,
  "notes": "Please arrive 10 minutes early.",
  "pixelId": "1234567890",
  "formSubmitType": "ThankYouMessage",
  "formSubmitRedirectURL": "https://example.com/thank-you",
  "formSubmitThanksMessage": "Thank you for booking!",
  "guestType": "count_only",
  "consentLabel": "I confirm that I want to receive content from this company using any contact information I provide.",
  "calendarCoverImage": "https://path-to-image.com",
  "lookBusyConfig": {
    "enabled": true,
    "lookBusyPercentage": 50
  },
  "appointmentPerSlot": 1,
  "appointmentPerDay": 8
}

application/json

Successful response

application/json

Schema

Schema

calendarobjectrequired

Calendar details

Example (auto)

{
  "calendar": {
    "id": "0TkCdp9PfvLeWKYRRvIz",
    "name": "test calendar",
    "locationId": "ocQHyuzHvysMo5N5VsXc"
  }
}