Create user availability schedule

POST

calendars

schedules

curl --request POST \
  --url https://services.leadconnectorhq.com/calendars/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "timezone": "America/New_York",
  "locationId": "IkqiJlXJ7o9h61tCHHod",
  "name": "Business Hours Schedule",
  "userId": "IkqiJlXJ7o9h61tCHHod",
  "rules": [
    {
      "type": "wday",
      "day": "monday",
      "intervals": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  ],
  "calendarIds": [
    "WvVX9LpvlBO6K506xLbp",
    "XyZ8MnQrStUvWxYzAbCdEf"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    Version: '<version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    timezone: 'America/New_York',
    locationId: 'IkqiJlXJ7o9h61tCHHod',
    name: 'Business Hours Schedule',
    userId: 'IkqiJlXJ7o9h61tCHHod',
    rules: [{type: 'wday', day: 'monday', intervals: [{from: '09:00', to: '17:00'}]}],
    calendarIds: ['WvVX9LpvlBO6K506xLbp', 'XyZ8MnQrStUvWxYzAbCdEf']
  })
};

fetch('https://services.leadconnectorhq.com/calendars/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/calendars/schedules"

payload = {
    "timezone": "America/New_York",
    "locationId": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "userId": "IkqiJlXJ7o9h61tCHHod",
    "rules": [
        {
            "type": "wday",
            "day": "monday",
            "intervals": [
                {
                    "from": "09:00",
                    "to": "17:00"
                }
            ]
        }
    ],
    "calendarIds": ["WvVX9LpvlBO6K506xLbp", "XyZ8MnQrStUvWxYzAbCdEf"]
}
headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "schedule": {
    "id": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "locationId": "IkqiJlXJ7o9h61tCHHod",
    "rules": [
      {
        "type": "wday",
        "intervals": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ],
        "date": "2023-04-15",
        "day": "monday"
      }
    ],
    "timezone": "America/New_York",
    "dateAdded": "2023-01-15T10:30:00.000Z",
    "dateUpdated": "2023-01-20T14:45:00.000Z",
    "userId": "IkqiJlXJ7o9h61tCHHod",
    "deleted": false,
    "calendarIds": [
      "<string>"
    ]
  }
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

Authorizations

Authorization

string

header

required

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Headers

Version

enum<string>

required

API Version

Available options:

2021-04-15

Body

application/json

timezone

string

required

Timezone for the schedule (IANA timezone identifier)

Pattern: ^[A-Za-z_]+/[A-Za-z_]+$

Example:

"America/New_York"

locationId

string

required

Location ID where this schedule applies

Example:

"IkqiJlXJ7o9h61tCHHod"

name

string

required

Human-readable name for the schedule

Example:

"Business Hours Schedule"

userId

string

required

User ID associated with the schedule

Example:

"IkqiJlXJ7o9h61tCHHod"

rules

object[]

Schedule rules defining when the schedule is active

Show child attributes

Example:

[
  {
    "type": "wday",
    "day": "monday",
    "intervals": [{ "from": "09:00", "to": "17:00" }]
  }
]

calendarIds

string[]

Calendar IDs associated with the schedule

Example:

[
  "WvVX9LpvlBO6K506xLbp",
  "XyZ8MnQrStUvWxYzAbCdEf"
]

Response

Schedule created successfully

schedule

object

required

Show child attributes

Last modified on March 8, 2026

Delete Calendar Resource

List user availability schedule

Create user availability schedule

curl --request POST \
  --url https://services.leadconnectorhq.com/calendars/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "timezone": "America/New_York",
  "locationId": "IkqiJlXJ7o9h61tCHHod",
  "name": "Business Hours Schedule",
  "userId": "IkqiJlXJ7o9h61tCHHod",
  "rules": [
    {
      "type": "wday",
      "day": "monday",
      "intervals": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  ],
  "calendarIds": [
    "WvVX9LpvlBO6K506xLbp",
    "XyZ8MnQrStUvWxYzAbCdEf"
  ]
}
'

const options = {
  method: 'POST',
  headers: {
    Version: '<version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    timezone: 'America/New_York',
    locationId: 'IkqiJlXJ7o9h61tCHHod',
    name: 'Business Hours Schedule',
    userId: 'IkqiJlXJ7o9h61tCHHod',
    rules: [{type: 'wday', day: 'monday', intervals: [{from: '09:00', to: '17:00'}]}],
    calendarIds: ['WvVX9LpvlBO6K506xLbp', 'XyZ8MnQrStUvWxYzAbCdEf']
  })
};

fetch('https://services.leadconnectorhq.com/calendars/schedules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://services.leadconnectorhq.com/calendars/schedules"

payload = {
    "timezone": "America/New_York",
    "locationId": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "userId": "IkqiJlXJ7o9h61tCHHod",
    "rules": [
        {
            "type": "wday",
            "day": "monday",
            "intervals": [
                {
                    "from": "09:00",
                    "to": "17:00"
                }
            ]
        }
    ],
    "calendarIds": ["WvVX9LpvlBO6K506xLbp", "XyZ8MnQrStUvWxYzAbCdEf"]
}
headers = {
    "Version": "<version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "schedule": {
    "id": "IkqiJlXJ7o9h61tCHHod",
    "name": "Business Hours Schedule",
    "locationId": "IkqiJlXJ7o9h61tCHHod",
    "rules": [
      {
        "type": "wday",
        "intervals": [
          {
            "from": "09:00",
            "to": "17:00"
          }
        ],
        "date": "2023-04-15",
        "day": "monday"
      }
    ],
    "timezone": "America/New_York",
    "dateAdded": "2023-01-15T10:30:00.000Z",
    "dateUpdated": "2023-01-20T14:45:00.000Z",
    "userId": "IkqiJlXJ7o9h61tCHHod",
    "deleted": false,
    "calendarIds": [
      "<string>"
    ]
  }
}

{
  "statusCode": 400,
  "message": "Bad Request"
}

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}