Create custom availability for scheduling-link

curl --request POST \
  --url https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "oliver@example.com",
  "name": "Meeting Specific Availability",
  "periods": [
    {
      "wday": "monday",
      "start_time": "09:00 AM",
      "end_time": "05:00 PM"
    },
    {
      "wday": "friday",
      "start_time": "10:00 AM",
      "end_time": "04:00 PM"
    }
  ],
  "overrides": [
    {
      "date": "2025-03-07",
      "periods": [
        {
          "start_time": "11:00 AM",
          "end_time": "04:00 PM"
        }
      ]
    }
  ],
  "time_zone": "America/New_York"
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'oliver@example.com',
    name: 'Meeting Specific Availability',
    periods: [
      {wday: 'monday', start_time: '09:00 AM', end_time: '05:00 PM'},
      {wday: 'friday', start_time: '10:00 AM', end_time: '04:00 PM'}
    ],
    overrides: [
      {date: '2025-03-07', periods: [{start_time: '11:00 AM', end_time: '04:00 PM'}]}
    ],
    time_zone: 'America/New_York'
  })
};

fetch('https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create"

payload = {
    "email": "oliver@example.com",
    "name": "Meeting Specific Availability",
    "periods": [
        {
            "wday": "monday",
            "start_time": "09:00 AM",
            "end_time": "05:00 PM"
        },
        {
            "wday": "friday",
            "start_time": "10:00 AM",
            "end_time": "04:00 PM"
        }
    ],
    "overrides": [
        {
            "date": "2025-03-07",
            "periods": [
                {
                    "start_time": "11:00 AM",
                    "end_time": "04:00 PM"
                }
            ]
        }
    ],
    "time_zone": "America/New_York"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "availability_id": "<string>",
  "member_id": "<string>",
  "meeting_id": "<string>",
  "availability": {
    "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
    "sid": "2nq7q5c",
    "name": "Availability for custom user",
    "default": false,
    "periods": [
      {
        "id": "21c812a7-3859-4f01-b214-850e6f11caad",
        "wday": "monday",
        "start_time": "09:00 AM",
        "end_time": "05:00 PM"
      }
    ],
    "overrides": [
      {
        "date": "2025-03-07",
        "periods": [
          {
            "start_time": "10:00 AM",
            "end_time": "03:00 PM"
          }
        ]
      }
    ],
    "user": {
      "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6",
      "name": "Oliver Smith",
      "email": "oliver@example.com"
    }
  }
}

POST

meetings

{meeting_sid}

availability

create

Create custom availability for scheduling-link

curl --request POST \
  --url https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "email": "oliver@example.com",
  "name": "Meeting Specific Availability",
  "periods": [
    {
      "wday": "monday",
      "start_time": "09:00 AM",
      "end_time": "05:00 PM"
    },
    {
      "wday": "friday",
      "start_time": "10:00 AM",
      "end_time": "04:00 PM"
    }
  ],
  "overrides": [
    {
      "date": "2025-03-07",
      "periods": [
        {
          "start_time": "11:00 AM",
          "end_time": "04:00 PM"
        }
      ]
    }
  ],
  "time_zone": "America/New_York"
}
'

const options = {
  method: 'POST',
  headers: {'X-Api-Key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'oliver@example.com',
    name: 'Meeting Specific Availability',
    periods: [
      {wday: 'monday', start_time: '09:00 AM', end_time: '05:00 PM'},
      {wday: 'friday', start_time: '10:00 AM', end_time: '04:00 PM'}
    ],
    overrides: [
      {date: '2025-03-07', periods: [{start_time: '11:00 AM', end_time: '04:00 PM'}]}
    ],
    time_zone: 'America/New_York'
  })
};

fetch('https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{your-subdomain}.neetocal.com/api/external/v1/meetings/{meeting_sid}/availability/create"

payload = {
    "email": "oliver@example.com",
    "name": "Meeting Specific Availability",
    "periods": [
        {
            "wday": "monday",
            "start_time": "09:00 AM",
            "end_time": "05:00 PM"
        },
        {
            "wday": "friday",
            "start_time": "10:00 AM",
            "end_time": "04:00 PM"
        }
    ],
    "overrides": [
        {
            "date": "2025-03-07",
            "periods": [
                {
                    "start_time": "11:00 AM",
                    "end_time": "04:00 PM"
                }
            ]
        }
    ],
    "time_zone": "America/New_York"
}
headers = {
    "X-Api-Key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "availability_id": "<string>",
  "member_id": "<string>",
  "meeting_id": "<string>",
  "availability": {
    "id": "01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a",
    "sid": "2nq7q5c",
    "name": "Availability for custom user",
    "default": false,
    "periods": [
      {
        "id": "21c812a7-3859-4f01-b214-850e6f11caad",
        "wday": "monday",
        "start_time": "09:00 AM",
        "end_time": "05:00 PM"
      }
    ],
    "overrides": [
      {
        "date": "2025-03-07",
        "periods": [
          {
            "start_time": "10:00 AM",
            "end_time": "03:00 PM"
          }
        ]
      }
    ],
    "user": {
      "id": "b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6",
      "name": "Oliver Smith",
      "email": "oliver@example.com"
    }
  }
}

This endpoint is part of API v1, which is deprecated. Please use the v2 API instead.

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

The created availability will be associated with the specified team member for this specific scheduling link. If the team member already has an availability for this meeting, it will be updated to use the newly created availability.

Headers

X-Api-Key

string

required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

meeting_sid

string

required

The unique SID of the scheduling link. You can get sid in different ways. Visit the scheduling link page and then click on "Settings" > "Show SID". That will give you sid. The other way you can get sid is by listing scheduling links using our List scheduling links API. Here you will see sid for each scheduling link.

Body

application/json

string<email>

required

Email of the team member who is a member of this scheduling link.

Example:

"oliver@example.com"

name

string

required

Name for the custom availability.

Example:

"Meeting Specific Availability"

periods

object[]

Hide child attributes

periods.wday

string

The weekday (e.g., "monday", "tuesday", etc.).

periods.start_time

string

Start time in "HH:MM AM/PM" format.

periods.end_time

string

End time in "HH:MM AM/PM" format.

Example:

[
  {
    "wday": "monday",
    "start_time": "09:00 AM",
    "end_time": "05:00 PM"
  },
  {
    "wday": "friday",
    "start_time": "10:00 AM",
    "end_time": "04:00 PM"
  }
]

overrides

object[]

Set an override for specific days. To set a date as unavailable, pass a blank array to the periods property. You can remove existing overrides by omitting the periods property.

Hide child attributes

overrides.date

string

The date (e.g, "2025-03-07")

overrides.periods

object[]

Set as blank ( [] ) to set a date as unavailable.

Hide child attributes

overrides.periods.start_time

string

Start time in "HH:MM AM/PM" format.

overrides.periods.end_time

string

End time in "HH:MM AM/PM" format.

Example:

[
  {
    "date": "2025-03-07",
    "periods": [
      {
        "start_time": "11:00 AM",
        "end_time": "04:00 PM"
      }
    ]
  }
]

time_zone

string

Optional IANA timezone name (e.g., "America/New_York", "Asia/Kolkata"). When provided, the start_time and end_time values in periods and overrides are assumed to be in this timezone and will be converted to the user's timezone before saving. If not provided, times are assumed to be in the user's timezone.

Example:

"America/New_York"

Response

200 - application/json

OK - Availability created and associated with meeting member successfully

availability_id

string

Unique identifier of the created availability.

member_id

string

Unique identifier of the team member.

meeting_id

string

Unique identifier of the meeting.

availability

object

Hide child attributes

availability.id

string

Unique identifier for the availability configuration.

Example:

"01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a"

availability.sid

string

Short identifier (SID) for the availability, used in URLs and API calls for easy reference.

Example:

"2nq7q5c"

availability.name

string

Human-readable name for the availability configuration (e.g., "Working hours", "Custom schedule").

Example:

"Availability for custom user"

availability.default

boolean

Indicates whether this is the default availability configuration for the team member. Only one availability can be set as default per user.

Example:

false

availability.periods

object[]

List of time periods defining when the team member is available for meetings throughout the week.

Hide child attributes

availability.periods.id

string

Unique identifier for this specific availability period.

Example:

"21c812a7-3859-4f01-b214-850e6f11caad"

availability.periods.wday

enum<string>

Day of the week for this availability period. Valid values are "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday".

Available options:

monday,

tuesday,

wednesday,

thursday,

friday,

saturday,

sunday

Example:

"monday"

availability.periods.start_time

string

Start time of the availability period in 12-hour format with AM/PM designation.

Example:

"09:00 AM"

availability.periods.end_time

string

End time of the availability period in 12-hour format with AM/PM designation.

Example:

"05:00 PM"

availability.overrides

object[]

List of date-specific availability overrides (e.g., holidays, vacation days, or special working hours for specific dates).

Hide child attributes

availability.overrides.date

string<date>

The specific date for this availability override in YYYY-MM-DD format.

Example:

"2025-03-07"

availability.overrides.periods

object[]

Time periods for this specific date. Set as empty array ([]) to mark the date as unavailable. If periods are provided, they override the regular weekly schedule for this date.

Hide child attributes

availability.overrides.periods.start_time

string

Start time for the override period in 12-hour format with AM/PM designation.

Example:

"10:00 AM"

availability.overrides.periods.end_time

string

End time for the override period in 12-hour format with AM/PM designation.

Example:

"03:00 PM"

availability.user

object

Information about the team member this availability configuration belongs to.

Hide child attributes

availability.user.id

string

Unique identifier for the user/team member.

Example:

"b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6"

availability.user.name

string

Full name of the team member.

Example:

"Oliver Smith"

availability.user.email

string<email>

Email address of the team member.

Example:

"oliver@example.com"

Getting started

Scheduling links

Meeting places

Meeting durations

Bookings

Availabilities

Slots

Packages

Team members

Meeting outcomes

Discount codes

Automation rules

Prefill tokens

API v1 (deprecated)

Create custom availability for scheduling-link

Headers

Path Parameters

Body

Response