> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetocal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create availability
> Create an availability for a team member.
This endpoint is part of API v1, which is deprecated. Please use the [v2 API](/getting-started/introduction) instead.
Replace `{your-subdomain}` with your workspace’s subdomain.
Learn how to find your subdomain in [Workspace subdomain](/getting-started/workspace-subdomain).
## OpenAPI
````yaml bundled-v1/availabilities.yaml POST /availabilities
openapi: 3.0.3
info:
title: NeetoCal Availabilities APIs
version: 1.0.0
servers:
- description: NeetoCal APIs
url: https://{your-subdomain}.neetocal.com/api/external/v1
variables:
your-subdomain:
default: spinkart
description: >-
Replace **spinkart** with your [workspace's
subdomain](/getting-started/workspace-subdomain).
security: []
tags:
- name: Availabilities
description: APIs to manage availabilities of meeting hosts.
paths:
/availabilities:
post:
tags:
- Availabilities
summary: Create an availability
description: Create an availability for a team member.
parameters:
- $ref: '#/components/parameters/api_key_header'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
format: email
description: >-
Email of the team member for whom the availability should be
created.
example: oliver@example.com
name:
type: string
description: Name for the custom availability.
example: Custom Work Hours
periods:
type: array
items:
type: object
properties:
wday:
type: string
description: The weekday (e.g., "monday", "tuesday", etc.).
start_time:
type: string
description: Start time in "HH:MM AM/PM" format.
end_time:
type: string
description: End time in "HH:MM AM/PM" format.
example:
- wday: monday
start_time: 09:00 AM
end_time: 05:00 PM
- wday: wednesday
start_time: 10:00 AM
end_time: 06:00 PM
overrides:
type: array
description: >-
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.
items:
type: object
properties:
date:
type: string
description: The date (e.g, "2025-03-07")
periods:
type: array
description: Set as blank ( [] ) to set a date as unavailable.
items:
type: object
properties:
start_time:
type: string
description: Start time in "HH:MM AM/PM" format.
end_time:
type: string
description: 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:
type: string
description: >-
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
required:
- email
- name
responses:
'200':
description: OK - Availability created successfully
content:
application/json:
schema:
type: object
properties:
availability:
$ref: '#/components/schemas/availability'
components:
parameters:
api_key_header:
in: header
name: X-Api-Key
description: >-
Use the X-Api-Key header to provide your workspace API key. Refer to
[Authentication](/getting-started/authentication) for more information.
required: true
schema:
type: string
schemas:
availability:
type: object
properties:
id:
type: string
description: Unique identifier for the availability configuration.
example: 01ea5ddf-ed00-4bed-bfa3-ba8ea80a856a
sid:
type: string
description: >-
Short identifier (SID) for the availability, used in URLs and API
calls for easy reference.
example: 2nq7q5c
name:
type: string
description: >-
Human-readable name for the availability configuration (e.g.,
"Working hours", "Custom schedule").
example: Availability for custom user
default:
type: boolean
description: >-
Indicates whether this is the default availability configuration for
the team member. Only one availability can be set as default per
user.
example: false
periods:
type: array
items:
$ref: '#/components/schemas/availability_period'
description: >-
List of time periods defining when the team member is available for
meetings throughout the week.
overrides:
type: array
items:
$ref: '#/components/schemas/availability_override'
description: >-
List of date-specific availability overrides (e.g., holidays,
vacation days, or special working hours for specific dates).
user:
$ref: '#/components/schemas/availability_user'
description: >-
Information about the team member this availability configuration
belongs to.
availability_period:
type: object
properties:
id:
type: string
description: Unique identifier for this specific availability period.
example: 21c812a7-3859-4f01-b214-850e6f11caad
wday:
type: string
description: >-
Day of the week for this availability period. Valid values are
"monday", "tuesday", "wednesday", "thursday", "friday", "saturday",
"sunday".
example: monday
enum:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
start_time:
type: string
description: >-
Start time of the availability period in 12-hour format with AM/PM
designation.
example: 09:00 AM
end_time:
type: string
description: >-
End time of the availability period in 12-hour format with AM/PM
designation.
example: 05:00 PM
availability_override:
type: object
properties:
date:
type: string
format: date
description: >-
The specific date for this availability override in YYYY-MM-DD
format.
example: '2025-03-07'
periods:
type: array
description: >-
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.
items:
type: object
properties:
start_time:
type: string
description: >-
Start time for the override period in 12-hour format with
AM/PM designation.
example: 10:00 AM
end_time:
type: string
description: >-
End time for the override period in 12-hour format with AM/PM
designation.
example: 03:00 PM
availability_user:
type: object
properties:
id:
type: string
description: Unique identifier for the user/team member.
example: b6d02dfa-8ef6-453d-b9f7-67a6f20bcaa6
name:
type: string
description: Full name of the team member.
example: Oliver Smith
email:
type: string
format: email
description: Email address of the team member.
example: oliver@example.com
````