addedInput schema / properties / body / properties / alertEmail / description
Added value: +"Alert email address"
addedInput schema / properties / body / properties / alertEmail / example
Added value: +"alerts@example.com"
addedInput schema / properties / body / properties / allowBookingAfter / example
Added value: +4
addedInput schema / properties / body / properties / allowBookingFor / example
Added value: +30
addedInput schema / properties / body / properties / allowCancellation / description
Added value: +"Allow cancellation of appointments"
addedInput schema / properties / body / properties / allowCancellation / example
Added value: +true
addedInput schema / properties / body / properties / allowReschedule / description
Added value: +"Allow rescheduling of appointments"
addedInput schema / properties / body / properties / allowReschedule / example
Added value: +true
addedInput schema / properties / body / properties / appoinmentPerDay / example
Added value: +8
addedInput schema / properties / body / properties / appoinmentPerSlot / description
Added value: +"Deprecated: use appointmentPerSlot instead. Maximum bookings per slot (per user)"
addedInput schema / properties / body / properties / appoinmentPerSlot / example
Added value: +1
addedInput schema / properties / body / properties / appointmentPerDay
Added value: +{
+ "description": "Number of appointments that can be booked for a given day",
+ "example": 8,
+ "type": "number"
+}
addedInput schema / properties / body / properties / appointmentPerSlot
Added value: +{
+ "description": "Maximum bookings per slot (per user)",
+ "example": 1,
+ "type": "number"
+}
addedInput schema / properties / body / properties / autoConfirm / description
Added value: +"Auto-confirm appointments"
addedInput schema / properties / body / properties / autoConfirm / example
Added value: +true
addedInput schema / properties / body / properties / availabilities / example
Added value: +[
+ {
+ "date": "2023-09-24T00:00:00.000Z",
+ "deleted": false,
+ "hours": [
+ {
+ "closeHour": 17,
+ "closeMinute": 0,
+ "openHour": 8,
+ "openMinute": 0
+ }
+ ],
+ "id": "YWxwZHlrZmR5bnpnbHdu"
+ }
+]
addedInput schema / properties / body / properties / availabilities / items / properties / deleted / description
Added value: +"Whether this availability is deleted"
addedInput schema / properties / body / properties / availabilities / items / properties / deleted / example
Added value: +false
addedInput schema / properties / body / properties / availabilities / items / properties / hours / description
Added value: +"Available hours for the date"
addedInput schema / properties / body / properties / availabilities / items / properties / hours / example
Added value: +[
+ {
+ "closeHour": 17,
+ "closeMinute": 0,
+ "openHour": 8,
+ "openMinute": 0
+ }
+]
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeHour / description
Added value: +"Closing hour (0-23)"
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeHour / example
Added value: +17
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeMinute / description
Added value: +"Closing minute (0-59)"
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / closeMinute / example
Added value: +0
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openHour / description
Added value: +"Opening hour (0-23)"
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openHour / example
Added value: +8
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openMinute / description
Added value: +"Opening minute (0-59)"
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / properties / openMinute / example
Added value: +0
addedInput schema / properties / body / properties / availabilities / items / properties / hours / items / title
Added value: +"Hour"
addedInput schema / properties / body / properties / availabilities / items / properties / id / example
Added value: +"YWxwZHlrZmR5bnpnbHdu"
addedInput schema / properties / body / properties / availabilities / items / title
Added value: +"UpdateAvailability"
addedInput schema / properties / body / properties / availabilityType / example
Added value: +0
addedInput schema / properties / body / properties / calendarCoverImage / description
Added value: +"Calendar cover image URL"
addedInput schema / properties / body / properties / calendarCoverImage / example
Added value: +"https://path-to-image.com"
addedInput schema / properties / body / properties / consentLabel / description
Added value: +"Consent label text"
addedInput schema / properties / body / properties / consentLabel / example
Added value: +"I confirm that I want to receive content from this company using any contact information I provide."
addedInput schema / properties / body / properties / countAvailableDaysOnly
Added value: +{
+ "default": false,
+ "description": "When true, only days with configured availability count toward the date range booking window",
+ "example": false,
+ "type": "boolean"
+}
addedInput schema / properties / body / properties / description / description
Added value: +"Calendar description"
addedInput schema / properties / body / properties / durationOptions
Added value: +{
+ "description": "Multiple duration options for the calendar. Bookers can select their preferred meeting length. Max 3 options. Exactly one must be marked as default.",
+ "example": [
+ {
+ "duration": 15,
+ "durationUnit": "mins",
+ "isDefault": false,
+ "order": 1
+ },
+ {
+ "duration": 30,
+ "durationUnit": "mins",
+ "isDefault": true,
+ "order": 2
+ }
+ ],
+ "items": {
+ "properties": {
+ "duration": {
+ "description": "Duration value in minutes",
+ "example": 30,
+ "type": "number"
+ },
+ "durationUnit": {
+ "description": "Unit for the duration",
+ "enum": [
+ "mins",
+ "hours"
+ ],
+ "example": "mins",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "Whether this is the default (pre-selected) duration",
+ "example": true,
+ "type": "boolean"
+ },
+ "order": {
+ "description": "Display order of the duration pill (1-based)",
+ "example": 1,
+ "type": "number"
+ }
+ },
+ "required": [
+ "duration",
+ "durationUnit",
+ "isDefault",
+ "order"
+ ],
+ "title": "DurationOptionDto",
+ "type": "object"
+ },
+ "type": "array"
+}
addedInput schema / properties / body / properties / enableRecurring / example
Added value: +false
addedInput schema / properties / body / properties / eventColor / description
Added value: +"Color for calendar events in hex format"
addedInput schema / properties / body / properties / eventColor / example
Added value: +"#039BE5"
addedInput schema / properties / body / properties / eventTitle / description
Added value: +"Title for calendar events"
addedInput schema / properties / body / properties / eventTitle / example
Added value: +"{{contact.name}}"
addedInput schema / properties / body / properties / eventType / description
Added value: +"Event type for round robin distribution"
addedInput schema / properties / body / properties / eventType / example
Added value: +"RoundRobin_OptimizeForAvailability"
addedInput schema / properties / body / properties / formId / description
Added value: +"Form ID to be used for booking"
addedInput schema / properties / body / properties / formId / example
Added value: +"YlWd2wuCAZQzh2cH1fVZ"
addedInput schema / properties / body / properties / formSubmitRedirectURL / description
Added value: +"Redirect URL after form submission"
addedInput schema / properties / body / properties / formSubmitRedirectURL / example
Added value: +"https://example.com/thank-you"
addedInput schema / properties / body / properties / formSubmitThanksMessage / description
Added value: +"Thank you message displayed after form submission"
addedInput schema / properties / body / properties / formSubmitThanksMessage / example
Added value: +"Thank you for booking!"
addedInput schema / properties / body / properties / formSubmitType / description
Added value: +"Action after form submission"
addedInput schema / properties / body / properties / formSubmitType / example
Added value: +"ThankYouMessage"
addedInput schema / properties / body / properties / googleInvitationEmails / description
Added value: +"Send Google invitation emails"
addedInput schema / properties / body / properties / googleInvitationEmails / example
Added value: +true
addedInput schema / properties / body / properties / guestType / description
Added value: +"Type of guest allowed"
addedInput schema / properties / body / properties / guestType / example
Added value: +"count_only"
addedInput schema / properties / body / properties / isActive / description
Added value: +"Whether the calendar is active"
addedInput schema / properties / body / properties / isActive / example
Added value: +true
addedInput schema / properties / body / properties / isLivePaymentMode / description
Added value: +"Whether payment mode is live"
addedInput schema / properties / body / properties / isLivePaymentMode / example
Added value: +false
addedInput schema / properties / body / properties / locationConfigurations / example
Added value: +[
+ {
+ "kind": "custom",
+ "location": "https://meet.google.com/abc-def"
+ }
+]
addedInput schema / properties / body / properties / locationConfigurations / items / properties / location / example
Added value: +"https://meet.google.com/abc-def"
addedInput schema / properties / body / properties / locationConfigurations / items / title
Added value: +"LocationConfiguration"
changedInput schema / properties / body / properties / lookBusyConfig / allOf
Previous value: -[
- {
- "properties": {
- "LookBusyPercentage": {
- "description": "Percentage of slots that will be hidden",
- "type": "number"
- },
- "enabled": {
- "default": false,
- "description": "Apply Look Busy",
- "example": true,
- "type": "boolean"
- }
- },
- "required": [
- "enabled",
- "LookBusyPercentage"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "LookBusyPercentage": {
+ "deprecated": true,
+ "description": "Percentage of slots that will be hidden (deprecated, use lookBusyPercentage)",
+ "example": 50,
+ "type": "number"
+ },
+ "enabled": {
+ "default": false,
+ "description": "Apply Look Busy",
+ "example": true,
+ "type": "boolean"
+ },
+ "lookBusyPercentage": {
+ "description": "Percentage of slots that will be hidden",
+ "example": 50,
+ "type": "number"
+ }
+ },
+ "required": [
+ "enabled",
+ "lookBusyPercentage"
+ ],
+ "title": "LookBusyConfiguration",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / properties / lookBusyConfig / example
Added value: +{
+ "enabled": true,
+ "lookBusyPercentage": 50
+}
addedInput schema / properties / body / properties / name / description
Added value: +"Calendar name"
addedInput schema / properties / body / properties / notes / description
Added value: +"Notes for the calendar"
addedInput schema / properties / body / properties / notes / example
Added value: +"Please arrive 10 minutes early."
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToContact / description
Added value: +"Send notification to contact"
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToContact / example
Added value: +false
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToGuest / description
Added value: +"Send notification to guest"
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToGuest / example
Added value: +false
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToSelectedUsers / description
Added value: +"Send notification to selected users"
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToSelectedUsers / example
Added value: +false
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToUser / description
Added value: +"Send notification to user"
addedInput schema / properties / body / properties / notifications / items / properties / shouldSendToUser / example
Added value: +false
addedInput schema / properties / body / properties / notifications / items / title
Added value: +"CalendarNotification"
addedInput schema / properties / body / properties / openHours / example
Added value: +[
+ {
+ "daysOfTheWeek": [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+ ],
+ "hours": [
+ {
+ "closeHour": 17,
+ "closeMinute": 0,
+ "openHour": 8,
+ "openMinute": 0
+ }
+ ]
+ }
+]
addedInput schema / properties / body / properties / openHours / items / properties / daysOfTheWeek / description
Added value: +"Days of the week (0=Sun, 6=Sat)"
addedInput schema / properties / body / properties / openHours / items / properties / daysOfTheWeek / example
Added value: +[
+ 1,
+ 2,
+ 3,
+ 4,
+ 5
+]
addedInput schema / properties / body / properties / openHours / items / properties / hours / description
Added value: +"Open hours for the specified days"
addedInput schema / properties / body / properties / openHours / items / properties / hours / example
Added value: +[
+ {
+ "closeHour": 17,
+ "closeMinute": 0,
+ "openHour": 8,
+ "openMinute": 0
+ }
+]
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeHour / description
Added value: +"Closing hour (0-23)"
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeHour / example
Added value: +17
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeMinute / description
Added value: +"Closing minute (0-59)"
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / closeMinute / example
Added value: +0
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openHour / description
Added value: +"Opening hour (0-23)"
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openHour / example
Added value: +8
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openMinute / description
Added value: +"Opening minute (0-59)"
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / properties / openMinute / example
Added value: +0
addedInput schema / properties / body / properties / openHours / items / properties / hours / items / title
Added value: +"Hour"
addedInput schema / properties / body / properties / openHours / items / title
Added value: +"OpenHour"
addedInput schema / properties / body / properties / pixelId / description
Added value: +"Facebook Pixel ID for tracking"
addedInput schema / properties / body / properties / pixelId / example
Added value: +"1234567890"
addedInput schema / properties / body / properties / preBuffer / example
Added value: +10
addedInput schema / properties / body / properties / preBufferUnit / example
Added value: +"mins"
addedInput schema / properties / body / properties / recurring / allOf
Added value: +[
+ {
+ "properties": {
+ "bookingOption": {
+ "description": "This setting contols what to do incase a recurring slot is unavailable",
+ "enum": [
+ "skip",
+ "continue",
+ "book_next"
+ ],
+ "example": "skip",
+ "type": "string"
+ },
+ "bookingOverlapDefaultStatus": {
+ "description": "This setting contols what to do incase a recurring slot is unavailable",
+ "enum": [
+ "confirmed",
+ "new"
+ ],
+ "example": "confirmed",
+ "type": "string"
+ },
+ "count": {
+ "description": "Number of recurrences",
+ "example": 4,
+ "maximum": 24,
+ "type": "number"
+ },
+ "freq": {
+ "description": "Frequency of recurrence",
+ "enum": [
+ "DAILY",
+ "WEEKLY",
+ "MONTHLY"
+ ],
+ "example": "WEEKLY",
+ "type": "string"
+ }
+ },
+ "title": "Recurring",
+ "type": "object"
+ }
+]
addedInput schema / properties / body / properties / recurring / description
Added value: +"Recurring appointment configuration"
addedInput schema / properties / body / properties / recurring / example
Added value: +{
+ "bookingOption": "skip",
+ "bookingOverlapDefaultStatus": "confirmed",
+ "count": 4,
+ "freq": "WEEKLY"
+}
removedInput schema / properties / body / properties / recurring / properties
Removed value: -{
- "bookingOption": {
- "description": "This setting contols what to do incase a recurring slot is unavailable",
- "enum": [
- "skip",
- "continue",
- "book_next"
- ],
- "type": "string"
- },
- "bookingOverlapDefaultStatus": {
- "description": "This setting contols what to do incase a recurring slot is unavailable",
- "enum": [
- "confirmed",
- "new"
- ],
- "type": "string"
- },
- "count": {
- "description": "Number of recurrences",
- "maximum": 24,
- "type": "number"
- },
- "freq": {
- "enum": [
- "DAILY",
- "WEEKLY",
- "MONTHLY"
- ],
- "type": "string"
- }
-}
removedInput schema / properties / body / properties / recurring / type
Removed value: -"object"
addedInput schema / properties / body / properties / shouldAssignContactToTeamMember / description
Added value: +"Assign contact to team member on booking"
addedInput schema / properties / body / properties / shouldAssignContactToTeamMember / example
Added value: +true
addedInput schema / properties / body / properties / shouldSendAlertEmailsToAssignedMember / description
Added value: +"Send alert emails to assigned team member"
addedInput schema / properties / body / properties / shouldSendAlertEmailsToAssignedMember / example
Added value: +false
addedInput schema / properties / body / properties / shouldSkipAssigningContactForExisting / description
Added value: +"Skip assigning contact if contact already exists"
addedInput schema / properties / body / properties / shouldSkipAssigningContactForExisting / example
Added value: +false
addedInput schema / properties / body / properties / slotBuffer / example
Added value: +15
addedInput schema / properties / body / properties / slotDuration / example
Added value: +30
addedInput schema / properties / body / properties / slotDurationUnit / example
Added value: +"mins"
addedInput schema / properties / body / properties / slotInterval / example
Added value: +30
addedInput schema / properties / body / properties / slotIntervalUnit / example
Added value: +"mins"
addedInput schema / properties / body / properties / slug / description
Added value: +"Calendar slug for URL"
addedInput schema / properties / body / properties / stickyContact / description
Added value: +"Enable sticky contact assignment"
addedInput schema / properties / body / properties / stickyContact / example
Added value: +true
addedInput schema / properties / body / properties / teamMembers / example
Added value: +[
+ {
+ "isPrimary": true,
+ "priority": 0.5,
+ "userId": "ocQHyuzHvysMo5N5VsXc"
+ }
+]
addedInput schema / properties / body / properties / teamMembers / items / properties / isPrimary / example
Added value: +true
addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / example
Added value: +[
+ {
+ "kind": "custom",
+ "location": "https://meet.google.com/abc-def"
+ }
+]
addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / items / properties / location / example
Added value: +"https://meet.google.com/abc-def"
addedInput schema / properties / body / properties / teamMembers / items / properties / locationConfigurations / items / title
Added value: +"LocationConfiguration"
addedInput schema / properties / body / properties / teamMembers / items / properties / priority / description
Added value: +"Priority of the team member for round robin"
addedInput schema / properties / body / properties / teamMembers / items / properties / priority / example
Added value: +0.5
addedInput schema / properties / body / properties / teamMembers / items / properties / userId / description
Added value: +"User ID of the team member"
addedInput schema / properties / body / properties / teamMembers / items / title
Added value: +"TeamMember"
addedInput schema / properties / body / properties / widgetSlug / description
Added value: +"Widget slug"
addedInput schema / properties / body / title
Added value: +"CalendarUpdateDTO"