Update Calendar

PUT https://services.leadconnectorhq.com/calendars/{calendarId}

Update calendar by ID.

Request

Security: Bearer Auth

Utiliza el Access Token generado con tipo de usuario Subcuenta o el Token de Integración Privada de la Subcuenta en PowerLeads. Proporciona tu token Bearer en el encabezado Authorization al realizar solicitudes a recursos protegidos.

Example: Authorization: Bearer 123

Path Parameters

calendarId

string

required

Calendar Id

Example: ocQHyuzHvysMo5N5VsXc

Headers

Authorization

string

required

Access Token

Example: Bearer 9c48df2694a849b6089f9d0d3513efe

Version

string

required

API Version

Allowed value: 2021-04-15

Body

groupId string
Group Id
Example: BqTwX8QFwXzpegMve9EQ

teamMembers array[object]

Team members

Example: ocQHyuzHvysMo5N5VsXc

userId string required
priority number
Allowed values: 0 0.5 1
Default: 0.5
isPrimary boolean
Marks a user as primary. This property is required in case of collective booking calendars. Only one user can be primary.
locationConfigurations array[object]
Meeting location configuration for event calendar.
- Multiple locations are allowed only when one team member is selected.
- For Class booking and Collective calendars, only one location configuration is allowed for each team member.

eventType string
Allowed values: RoundRobin_OptimizeForAvailability RoundRobin_OptimizeForEqualDistribution

name string
Example: test calendar

description string
Example: this is used for testing

slug string
Example: test1

widgetSlug string
Example: test1

widgetType string
Calendar widget type. Choose "default" for "neo" and "classic" for "classic" layout.

Allowed values: default classic
Default: classic
Example: classic

eventTitle string

eventColor string
Default: #039be5

locationConfigurations array[object]

Meeting location configuration for event calendar

kind

string

required

Type of meeting location. zoom_conference/google_conference/ms_teams_conference is not supported in event calendar type

Allowed values: custom zoom_conference google_conference inbound_call outbound_call physical booker ms_teams_conference
Example: custom

location

string

Address for meeting location. Not applicable on "zoom_conference", "google_conference" and "ms_teams_conference" kind

Examples: +14455550132 http://meet.google.com/your-meeting-location

slotDuration number
This controls the duration of the meeting
Default: 30

slotDurationUnit string
Unit for slot duration.
Allowed values: mins hours

preBufferUnit string
Unit for pre-buffer.
Allowed values: mins hours

slotInterval number
Slot interval reflects the amount of time the between booking slots that will be shown in the calendar.
Default: 30

slotInterval unit
Unit for slot interval.
Default: mins hours

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

appoinmentPerSlot number

appoinmentPerDay number
Number of appointments that can be booked for a given day

allowBookingAfter number
Minimum scheduling notice for events

allowBookingAfterUnit string
Unit for minimum scheduling notice
Allowed values: hours days weeks months
Example: days

Request Sample: Shell / cURL

curl --request PUT \
  --url https://services.leadconnectorhq.com/calendars/ocQHyuzHvysMo5N5VsXc \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --header 'Version: 2021-04-15' \
  --data '{
  "notifications": [
    {
      "type": "email",
      "shouldSendToContact": true,
      "shouldSendToGuest": true,
      "shouldSendToUser": true,
      "shouldSendToSelectedUsers": true,
      "selectedUsers": "user1@testemail.com,user2@testemail.com"
    }
  ],
  "groupId": "BqTwX8QFwXzpegMve9EQ",
  "teamMembers": [
    {
      "userId": "ocQHyuzHvysMo5N5VsXc",
      "priority": 0.5,
      "isPrimary": true,
      "locationConfigurations": [
        {
          "kind": "custom",
          "location": "+14455550132"
        }
      ]
    }
  ],
  "eventType": "RoundRobin_OptimizeForAvailability",
  "name": "test calendar",
  "description": "this is used for testing",
  "slug": "test1",
  "widgetSlug": "test1",
  "widgetType": "classic",
  "eventTitle": "string",
  "eventColor": "#039be5",
  "locationConfigurations": [
    {
      "kind": "custom",
      "location": "+14455550132"
    }
  ],
  "slotDuration": 30,
  "slotDurationUnit": "mins",
  "preBufferUnit": "mins",
  "slotInterval": 30,
  "slotIntervalUnit": "mins",
  "slotBuffer": 0,
  "preBuffer": 0,
  "appoinmentPerSlot": 0,
  "appoinmentPerDay": 0,
  "allowBookingAfter": 0,
  "allowBookingAfterUnit": "hours",
  "allowBookingFor": 0,
  "allowBookingForUnit": "days",
  "openHours": [
    {
      "daysOfTheWeek": [
        0
      ],
      "hours": [
        {
          "openHour": 0,
          "openMinute": 0,
          "closeHour": 0,
          "closeMinute": 0
        }
      ]
    }
  ],
  "enableRecurring": false,
  "recurring": {
    "freq": "DAILY",
    "count": 24,
    "bookingOption": "skip",
    "bookingOverlapDefaultStatus": "confirmed"
  },
  "formId": "string",
  "stickyContact": true,
  "isLivePaymentMode": true,
  "autoConfirm": true,
  "shouldSendAlertEmailsToAssignedMember": true,
  "alertEmail": "string",
  "googleInvitationEmails": true,
  "allowReschedule": true,
  "allowCancellation": true,
  "shouldAssignContactToTeamMember": true,
  "shouldSkipAssigningContactForExisting": true,
  "notes": "string",
  "pixelId": "string",
  "formSubmitType": "ThankYouMessage",
  "formSubmitRedirectURL": "string",
  "formSubmitThanksMessage": "string",
  "availabilityType": 0,
  "availabilities": [
    {
      "date": "2023-09-24T00:00:00.000Z",
      "hours": [
        {
          "openHour": 0,
          "openMinute": 0,
          "closeHour": 0,
          "closeMinute": 0
        }
      ],
      "deleted": false,
      "id": "string"
    }
  ],
  "guestType": "count_only",
  "consentLabel": "string",
  "calendarCoverImage": "string",
  "lookBusyConfig": {
    "enabled": true,
    "LookBusyPercentage": 0
  },
  "isActive": true
}'

Response Example

{
  "calendar": {
    "isActive": true,
    "notifications": [
      {
        "type": "email",
        "shouldSendToContact": true,
        "shouldSendToGuest": true,
        "shouldSendToUser": true,
        "shouldSendToSelectedUsers": true,
        "selectedUsers": "user1@testemail.com,user2@testemail.com"
      }
    ],
    "locationId": "ocQHyuzHvysMo5N5VsXc",
    "groupId": "BqTwX8QFwXzpegMve9EQ",
    "teamMembers": [
      {
        "userId": "ocQHyuzHvysMo5N5VsXc",
        "priority": 0.5,
        "meetingLocationType": "custom",
        "meetingLocation": "string",
        "isPrimary": true,
        "locationConfigurations": [
          {
            "kind": "custom",
            "location": "+14455550132",
            "meetingId": "my_conference_id"
          }
        ]
      }
    ],
    "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",
    "meetingLocation": "string",
    "locationConfigurations": [
      {
        "kind": "custom",
        "location": "+14455550132",
        "meetingId": "my_conference_id"
      }
    ],
    "slotDuration": 30,
    "slotDurationUnit": "mins",
    "slotInterval": 30,
    "slotIntervalUnit": "mins",
    "slotBuffer": 0,
    "slotBufferUnit": "mins",
    "preBuffer": 0,
    "preBufferUnit": "mins",
    "appoinmentPerSlot": 1,
    "appoinmentPerDay": 0,
    "allowBookingAfter": 0,
    "allowBookingAfterUnit": "days",
    "allowBookingFor": 0,
    "allowBookingForUnit": "days",
    "openHours": [
      {
        "daysOfTheWeek": [
          0
        ],
        "hours": [
          {
            "openHour": 0,
            "openMinute": 0,
            "closeHour": 0,
            "closeMinute": 0
          }
        ]
      }
    ],
    "enableRecurring": false,
    "recurring": {
      "freq": "DAILY",
      "count": 24,
      "bookingOption": "skip",
      "bookingOverlapDefaultStatus": "confirmed"
    },
    "formId": "string",
    "stickyContact": true,
    "isLivePaymentMode": true,
    "autoConfirm": true,
    "shouldSendAlertEmailsToAssignedMember": true,
    "alertEmail": "string",
    "googleInvitationEmails": false,
    "allowReschedule": true,
    "allowCancellation": true,
    "shouldAssignContactToTeamMember": true,
    "shouldSkipAssigningContactForExisting": true,
    "notes": "string",
    "pixelId": "string",
    "formSubmitType": "ThankYouMessage",
    "formSubmitRedirectURL": "string",
    "formSubmitThanksMessage": "string",
    "availabilityType": 0,
    "availabilities": [
      {
        "date": "2023-09-24T00:00:00.000Z",
        "hours": [
          {
            "openHour": 0,
            "openMinute": 0,
            "closeHour": 0,
            "closeMinute": 0
          }
        ],
        "deleted": false
      }
    ],
    "guestType": "count_only",
    "consentLabel": "string",
    "calendarCoverImage": "https://path-to-image.com",
    "lookBusyConfig": {
      "enabled": true,
      "LookBusyPercentage": 0
    },
    "id": "0TkCdp9PfvLeWKYRRvIz"
  }
}