Create scheduling link - NeetoCal API

Create a scheduling link

curl --request POST \
  --url https://{your-subdomain}.neetocal.com/api/external/v2/meetings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "slug": "meeting-with-oliver-smith",
  "name": "Meeting with Oliver Smith",
  "hosts": [
    "oliver@example.com",
    "jane@example.com"
  ],
  "duration": 30,
  "template_id": "cc98d282-4cf6-414d-ba58-53fa94b9bca3",
  "description": "Discuss project updates",
  "kind": "one_on_one",
  "start_time_increment": 30,
  "before_buffer_time": 0,
  "after_buffer_time": 0,
  "is_multiple_durations_allowed": false,
  "is_multiple_spots_allowed": false,
  "spot_phone_call_number": "+1-555-0123",
  "spot_custom_text": "Custom meeting instructions",
  "spot_in_person_location": "123 Main St, Suite 100",
  "locked_time_zone": "America/New_York",
  "durations": [
    {
      "id": "4ece6b6b-4b5f-4c15-9122-a85af189198c",
      "duration": 30,
      "is_default": true,
      "created_at": "2025-08-18T07:43:16.775Z",
      "updated_at": "2025-08-18T08:03:58.019Z"
    }
  ],
  "spots": [
    {
      "id": "bcc90342-9345-4d89-9144-d25d7c7b3521",
      "spot": "zoom",
      "is_default": true,
      "phone_call_number": null,
      "in_person_location": null,
      "custom_text": null,
      "created_at": "2025-08-18T07:19:28.341Z",
      "updated_at": "2025-08-18T07:35:32.822Z"
    }
  ]
}
'

{
  "message": "Meeting created successfully",
  "meeting": {
    "id": "<string>",
    "sid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "duration": 123,
    "disabled": true,
    "spot_in_person_location": "<string>",
    "spot_custom_text": "<string>",
    "spot_phone_call_number": "<string>",
    "is_template": true,
    "schedulable_range_value": "<string>",
    "lead_time": 123,
    "start_time_increment": 123,
    "before_buffer_time": 0,
    "after_buffer_time": 0,
    "created_at": "2025-12-23T05:05:27.037Z",
    "updated_at": "2025-03-31T13:22:19.832Z",
    "deleted_at": null,
    "is_multiple_spots_allowed": true,
    "is_multiple_durations_allowed": true,
    "conditional_pricing_enabled": true,
    "is_email_reminders_enabled": true,
    "is_sms_reminders_enabled": true,
    "organization_id": "<string>",
    "rescheduling_lead_time": 123,
    "cancellation_lead_time": 123,
    "booking_modification_allowed": true,
    "cancellation_too_late_notice": "<string>",
    "cancellation_policy": "<string>",
    "rescheduling_too_late_notice": "<string>",
    "pre_booking_allowed": true,
    "original_price_enabled": true,
    "original_price": 123,
    "locked_time_zone": "America/New_York",
    "fees": [
      {
        "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9",
        "amount": "120.0",
        "currency": "inr",
        "feeable_id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20",
        "feeable_type": "Meeting",
        "payment_provider": "cash",
        "kind": "fixed",
        "min_amount": "120.0",
        "is_default": true,
        "display_amount": "<string>",
        "is_tax_enabled": true,
        "is_tip_enabled": true,
        "is_tax_applicable_on_tip": true,
        "vpas": [
          {}
        ],
        "recipient": {
          "id": "<string>",
          "fee_id": "<string>",
          "accountable": {}
        },
        "amount_in_smallest_currency_unit": 12000
      }
    ],
    "durations_possible": [
      123
    ],
    "durations": [
      {
        "id": "4ece6b6b-4b5f-4c15-9122-a85af189198c",
        "duration": 30,
        "is_default": false,
        "created_at": "2025-08-18T07:43:16.775Z",
        "updated_at": "2025-08-18T08:03:58.019Z"
      }
    ],
    "hosts": [
      {
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      }
    ],
    "spots": [
      {
        "id": "bcc90342-9345-4d89-9144-d25d7c7b3521",
        "spot": "jitsi",
        "is_default": false,
        "phone_call_number": null,
        "in_person_location": null,
        "custom_text": null,
        "created_at": "2025-08-18T07:19:28.341Z",
        "updated_at": "2025-08-18T07:35:32.822Z"
      }
    ]
  }
}

POST

meetings

Create a scheduling link

curl --request POST \
  --url https://{your-subdomain}.neetocal.com/api/external/v2/meetings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "slug": "meeting-with-oliver-smith",
  "name": "Meeting with Oliver Smith",
  "hosts": [
    "oliver@example.com",
    "jane@example.com"
  ],
  "duration": 30,
  "template_id": "cc98d282-4cf6-414d-ba58-53fa94b9bca3",
  "description": "Discuss project updates",
  "kind": "one_on_one",
  "start_time_increment": 30,
  "before_buffer_time": 0,
  "after_buffer_time": 0,
  "is_multiple_durations_allowed": false,
  "is_multiple_spots_allowed": false,
  "spot_phone_call_number": "+1-555-0123",
  "spot_custom_text": "Custom meeting instructions",
  "spot_in_person_location": "123 Main St, Suite 100",
  "locked_time_zone": "America/New_York",
  "durations": [
    {
      "id": "4ece6b6b-4b5f-4c15-9122-a85af189198c",
      "duration": 30,
      "is_default": true,
      "created_at": "2025-08-18T07:43:16.775Z",
      "updated_at": "2025-08-18T08:03:58.019Z"
    }
  ],
  "spots": [
    {
      "id": "bcc90342-9345-4d89-9144-d25d7c7b3521",
      "spot": "zoom",
      "is_default": true,
      "phone_call_number": null,
      "in_person_location": null,
      "custom_text": null,
      "created_at": "2025-08-18T07:19:28.341Z",
      "updated_at": "2025-08-18T07:35:32.822Z"
    }
  ]
}
'

{
  "message": "Meeting created successfully",
  "meeting": {
    "id": "<string>",
    "sid": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "description": "<string>",
    "duration": 123,
    "disabled": true,
    "spot_in_person_location": "<string>",
    "spot_custom_text": "<string>",
    "spot_phone_call_number": "<string>",
    "is_template": true,
    "schedulable_range_value": "<string>",
    "lead_time": 123,
    "start_time_increment": 123,
    "before_buffer_time": 0,
    "after_buffer_time": 0,
    "created_at": "2025-12-23T05:05:27.037Z",
    "updated_at": "2025-03-31T13:22:19.832Z",
    "deleted_at": null,
    "is_multiple_spots_allowed": true,
    "is_multiple_durations_allowed": true,
    "conditional_pricing_enabled": true,
    "is_email_reminders_enabled": true,
    "is_sms_reminders_enabled": true,
    "organization_id": "<string>",
    "rescheduling_lead_time": 123,
    "cancellation_lead_time": 123,
    "booking_modification_allowed": true,
    "cancellation_too_late_notice": "<string>",
    "cancellation_policy": "<string>",
    "rescheduling_too_late_notice": "<string>",
    "pre_booking_allowed": true,
    "original_price_enabled": true,
    "original_price": 123,
    "locked_time_zone": "America/New_York",
    "fees": [
      {
        "id": "1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9",
        "amount": "120.0",
        "currency": "inr",
        "feeable_id": "aff17ff8-1bf8-4e77-a3c5-2f86104f9a20",
        "feeable_type": "Meeting",
        "payment_provider": "cash",
        "kind": "fixed",
        "min_amount": "120.0",
        "is_default": true,
        "display_amount": "<string>",
        "is_tax_enabled": true,
        "is_tip_enabled": true,
        "is_tax_applicable_on_tip": true,
        "vpas": [
          {}
        ],
        "recipient": {
          "id": "<string>",
          "fee_id": "<string>",
          "accountable": {}
        },
        "amount_in_smallest_currency_unit": 12000
      }
    ],
    "durations_possible": [
      123
    ],
    "durations": [
      {
        "id": "4ece6b6b-4b5f-4c15-9122-a85af189198c",
        "duration": 30,
        "is_default": false,
        "created_at": "2025-08-18T07:43:16.775Z",
        "updated_at": "2025-08-18T08:03:58.019Z"
      }
    ],
    "hosts": [
      {
        "name": "Oliver Smith",
        "email": "oliver@example.com"
      }
    ],
    "spots": [
      {
        "id": "bcc90342-9345-4d89-9144-d25d7c7b3521",
        "spot": "jitsi",
        "is_default": false,
        "phone_call_number": null,
        "in_person_location": null,
        "custom_text": null,
        "created_at": "2025-08-18T07:19:28.341Z",
        "updated_at": "2025-08-18T07:35:32.822Z"
      }
    ]
  }
}

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

Creating from scratch

Provide all the required configuration values directly in your request.

Creating from a template

To create a scheduling link from an existing template, include the template_id field in your request. When a template is used:

All template configuration values are automatically copied.
Values you provide in the same request override the template values.

Note: You can find available template IDs using the List scheduling link templates endpoint. Example with template:

{
  "template_id": "cc98d282-4cf6-414d-ba58-53fa94b9bca3",
  "slug": "testing-meeting",
  "name": "Testing",
  "hosts": ["oliver@example.com"],
  "duration": 45
}

Headers

X-Api-Key

string

required

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

Body

application/json

slug

string

required

Slug of the scheduling link. This value should be unique.

Example:

"meeting-with-oliver-smith"

name

string

required

Name of the scheduling link.

Example:

"Meeting with Oliver Smith"

hosts

string[]

required

Emails of the hosts of scheduling link in array format.

Example:

["oliver@example.com", "jane@example.com"]

duration

integer

required

Duration of the scheduling link in minutes.

Example:

30

template_id

string

ID of an existing meeting template to use as a base. When provided, all template values will be copied to the new scheduling link. Values passed in the same request will override template values.

Example:

"cc98d282-4cf6-414d-ba58-53fa94b9bca3"

description

string

Description of the scheduling link.

Example:

"Discuss project updates"

kind

enum<string>

default:one_on_one

Kind of scheduling link.

Available options:

one_on_one,

round_robin,

multihost,

grouped

start_time_increment

integer

Start time increment for the scheduling link in minutes. Defaults to 30.

Example:

30

before_buffer_time

integer

Buffer time in minutes before each meeting to allow for setup, preparation, or travel time. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

after_buffer_time

integer

Buffer time in minutes after each meeting to allow for wrap-up, notes, or preparation for the next meeting. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

is_multiple_durations_allowed

boolean

Whether users can select from multiple meeting duration options.

Example:

false

is_multiple_spots_allowed

boolean

Whether users can select from multiple meeting platforms/locations.

Example:

false

spot_phone_call_number

string

Phone number for the meeting when place is set to phone_call.

Example:

"+1-555-0123"

spot_custom_text

string

Custom meeting instructions or details when meeting place is set to custom.

Example:

"Custom meeting instructions"

spot_in_person_location

string

Physical location details when meeting place is set to in_person.

Example:

"123 Main St, Suite 100"

locked_time_zone

string

Time zone to lock the scheduling link to. When set, all available times are displayed in this time zone regardless of the booker's location. Must be a valid IANA time zone identifier (e.g., 'America/New_York', 'Europe/London').

Example:

"America/New_York"

durations

object[]

Array of duration options when multiple durations are allowed.

Hide child attributes

durations.id

string

Unique identifier for the duration option.

Example:

"4ece6b6b-4b5f-4c15-9122-a85af189198c"

durations.duration

integer

Duration in minutes (1-1440).

Example:

30

durations.is_default

boolean

Whether this duration is the default option.

Example:

true

durations.created_at

string<date-time>

Timestamp when the duration option was created.

Example:

"2025-08-18T07:43:16.775Z"

durations.updated_at

string<date-time>

Timestamp when the duration option was last updated.

Example:

"2025-08-18T08:03:58.019Z"

spots

object[]

Array of place options when multiple places are allowed.

Hide child attributes

spots.id

string

Unique identifier for the meeting place option.

Example:

"bcc90342-9345-4d89-9144-d25d7c7b3521"

spots.spot

enum<string>

The place type for the meeting.

Available options:

daily,

zoom,

jitsi,

google_meet,

teams,

whereby,

in_person,

custom,

phone_call

Example:

"zoom"

spots.is_default

boolean

Whether this meeting place is the default option.

Example:

true

spots.phone_call_number

string | null

Phone number for phone call meeting place. Only populated when place type is "phone_call", otherwise null.

Example:

null

spots.in_person_location

string | null

Location details for in-person meetings. Only populated when place type is "in_person", otherwise null.

Example:

null

spots.custom_text

string | null

Custom text for custom meeting place. Only populated when place type is "custom", otherwise null.

Example:

null

spots.created_at

string<date-time>

Timestamp when the meeting place option was created.

Example:

"2025-08-18T07:19:28.341Z"

spots.updated_at

string<date-time>

Timestamp when the meeting place option was last updated.

Example:

"2025-08-18T07:35:32.822Z"

Response

201 - application/json

Created - Resource created successfully

message

string

Example:

"Meeting created successfully"

meeting

object

Hide child attributes

meeting.id

string

Unique identifier for the scheduling link.

meeting.sid

string

Short identifier (SID) for the meeting, used in URLs and API calls.

meeting.name

string

Display name of the scheduling link.

meeting.slug

string

URL-friendly identifier for the meeting, used in public scheduling links.

meeting.description

string

Detailed description of the meeting purpose or agenda.

meeting.kind

enum<string>

Type of meeting. one_on_one for individual meetings, round_robin for rotating hosts, multihost for multiple simultaneous hosts, grouped for group sessions.

Available options:

one_on_one,

round_robin,

multihost,

grouped

meeting.duration

integer

Duration of the meeting in minutes.

meeting.disabled

boolean

Whether the scheduling link is currently disabled and not accepting bookings.

meeting.spot

enum<string>

Meeting platform or location type for the scheduled meeting.

Available options:

custom,

jitsi,

google_meet,

daily,

zoom,

whereby,

teams,

phone_call,

in_person

meeting.spot_in_person_location

string | null

Physical location details when meeting place is set to in_person.

meeting.spot_custom_text

string | null

Custom meeting instructions or details when meeting place is set to custom.

meeting.spot_phone_call_number

string | null

Phone number for the meeting when place is set to phone_call.

meeting.is_template

boolean

Whether this meeting is a template that can be used to create other meetings.

meeting.schedulable_range_type

enum<string>

How the scheduling range is calculated - by days into future, business days, or specific date range.

Available options:

number_of_days_into_the_future,

number_of_business_days_into_the_future,

date_range

meeting.schedulable_range_value

string

Value for the scheduling range (e.g., number of days or date range).

meeting.lead_time

integer

Minimum advance notice required for booking in minutes.

meeting.start_time_increment

integer

Time increment in minutes for available booking slots (e.g., 30 for 30-minute slots).

meeting.before_buffer_time

integer

Buffer time in minutes before each meeting to allow for setup, preparation, or travel time. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

meeting.after_buffer_time

integer

Buffer time in minutes after each meeting to allow for wrap-up, notes, or preparation for the next meeting. Must be between 0 and 1440 (24 hours).

Required range: 0 <= x <= 1440

Example:

0

meeting.created_at

string

Timestamp when the meeting was created.

Example:

"2025-12-23T05:05:27.037Z"

meeting.updated_at

string

Timestamp when the meeting was last updated.

Example:

"2025-03-31T13:22:19.832Z"

meeting.deleted_at

string | null

Timestamp when the meeting was deleted (soft delete).

Example:

null

meeting.is_multiple_spots_allowed

boolean

Whether users can select from multiple meeting places.

meeting.is_multiple_durations_allowed

boolean

Whether users can select from multiple meeting duration options.

meeting.conditional_pricing_enabled

boolean

Whether conditional pricing rules are applied to this meeting.

meeting.is_email_reminders_enabled

boolean

Whether email reminders are sent for this meeting.

meeting.is_sms_reminders_enabled

boolean

Whether SMS reminders are sent for this meeting.

meeting.organization_id

string

Unique identifier of the organization that owns this meeting.

meeting.rescheduling_lead_time

integer

Minimum advance notice required for rescheduling in minutes.

meeting.cancellation_lead_time

integer

Minimum advance notice required for cancellation in minutes.

meeting.booking_modification_allowed

boolean

Whether users are allowed to modify their bookings after creation.

meeting.cancellation_too_late_notice

string | null

Custom message shown when cancellation is attempted too late.

meeting.cancellation_policy

string | null

Policy text explaining cancellation terms and conditions.

meeting.rescheduling_too_late_notice

string | null

Custom message shown when rescheduling is attempted too late.

meeting.pre_booking_allowed

boolean

Whether users can book meetings in advance beyond the normal scheduling range.

meeting.original_price_enabled

boolean

Whether to show the original price alongside any discounted price.

meeting.original_price

number | null

Original price of the meeting before any discounts.

meeting.locked_time_zone

string | null

Example:

"America/New_York"

meeting.fees

object[]

Fees or charges associated with the meeting (scheduling link).

Hide child attributes

meeting.fees.id

string

Unique identifier for the fee configuration.

Example:

"1b217cc5-69b5-4fb1-a13c-c22f9c14e7f9"

meeting.fees.amount

string

The fee amount as a string to preserve decimal precision.

Example:

"120.0"

meeting.fees.currency

string

The currency code for the fee amount. Follows the ISO 4217 standard (e.g., "inr", "usd").

Example:

"inr"

meeting.fees.feeable_id

string

ID of the entity this fee is associated with (meeting ID in this case).

Example:

"aff17ff8-1bf8-4e77-a3c5-2f86104f9a20"

meeting.fees.feeable_type

string

Type of entity this fee is associated with.

Example:

"Meeting"

meeting.fees.payment_provider

enum<string>

Payment service provider used for processing payments.

Available options:

stripe,

razorpay,

cash,

paypal,

dodopayments

Example:

"cash"

meeting.fees.kind

string

Type of fee structure (e.g., "fixed", "percentage").

Example:

"fixed"

meeting.fees.min_amount

string

Minimum amount that can be charged for this fee.

Example:

"120.0"

meeting.fees.is_default

boolean

Indicates whether this is the default fee configuration for the meeting.

meeting.fees.display_amount

string | null

Custom display amount for the fee (if different from the actual amount).

meeting.fees.is_tax_enabled

boolean

Whether tax calculation is enabled for this fee.

meeting.fees.is_tip_enabled

boolean

Whether tipping is enabled for this fee.

meeting.fees.is_tax_applicable_on_tip

boolean

Whether taxes are calculated on top of tips.

meeting.fees.vpas

object[]

Virtual Payment Addresses for UPI payments (India-specific).

meeting.fees.recipient

object

The payment recipient configured for this fee.

Hide child attributes

meeting.fees.recipient.id

string

Unique identifier for the recipient.

meeting.fees.recipient.fee_id

string

ID of the fee this recipient belongs to.

meeting.fees.recipient.accountable

object

The connected payment account that receives the payout.

meeting.fees.amount_in_smallest_currency_unit

integer

Fee amount in the smallest currency unit (e.g., paise for INR, cents for USD).

Example:

12000

meeting.durations_possible

integer[]

List of available duration options in minutes when multiple durations are allowed.

meeting.durations

object[]

Hide child attributes

meeting.durations.id

string

Unique identifier for the duration option.

Example:

"4ece6b6b-4b5f-4c15-9122-a85af189198c"

meeting.durations.duration

integer

Duration in minutes.

Example:

30

meeting.durations.is_default

boolean

Whether this duration is the default option.

Example:

false

meeting.durations.created_at

string<date-time>

Timestamp when the duration option was created.

Example:

"2025-08-18T07:43:16.775Z"

meeting.durations.updated_at

string<date-time>

Timestamp when the duration option was last updated.

Example:

"2025-08-18T08:03:58.019Z"

meeting.hosts

object[]

List of hosts for the scheduling link with their name and email.

Hide child attributes

meeting.hosts.name

string

Full name of the host.

Example:

"Oliver Smith"

meeting.hosts.email

string

Email address of the host.

Example:

"oliver@example.com"

meeting.spots

object[]

Hide child attributes

meeting.spots.id

string

Unique identifier for the meeting place option.

Example:

"bcc90342-9345-4d89-9144-d25d7c7b3521"

meeting.spots.spot

enum<string>

The place type for the meeting.

Available options:

daily,

zoom,

jitsi,

google_meet,

teams,

whereby,

in_person,

custom,

phone_call

Example:

"jitsi"

meeting.spots.is_default

boolean

Whether this meeting place is the default option.

Example:

false

meeting.spots.phone_call_number

string | null

Phone number for phone call meeting place. Only populated when place type is "phone_call", otherwise null.

Example:

null

meeting.spots.in_person_location

string | null

Location details for in-person meetings. Only populated when place type is "in_person", otherwise null.

Example:

null

meeting.spots.custom_text

string | null

Custom text for custom meeting place. Only populated when place type is "custom", otherwise null.

Example:

null

meeting.spots.created_at

string<date-time>

Timestamp when the meeting place option was created.

Example:

"2025-08-18T07:19:28.341Z"

meeting.spots.updated_at

string<date-time>

Timestamp when the meeting place option was last updated.

Example:

"2025-08-18T07:35:32.822Z"

Get scheduling link template Update scheduling link

​Creating from scratch

​Creating from a template

Headers

Body

Response

Creating from scratch

Creating from a template