Create Share | Calendly | Developer Documentation

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.shares.createShare({
        eventType: "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
        name: "15 Minute Meeting",
        duration: 15,
        durationOptions: [
            1,
            13,
            15,
            720,
        ],
        periodType: "available_moving",
        startDate: "2019-01-02",
        endDate: "2019-01-03",
        maxBookingTime: 300,
        hideLocation: true,
        locationConfigurations: [
            {
                location: "123 Abc St.",
                additionalInfo: "Example additional information",
                position: 0,
                kind: "physical",
            },
        ],
        availabilityRule: {
            rules: [
                {
                    type: "wday",
                    wday: "sunday",
                    intervals: [
                        {
                            from: "07:00",
                            to: "11:00",
                        },
                    ],
                },
            ],
            timezone: "America/New_York",
        },
    });
}
main();

{
  "resource": {
    "scheduling_links": [
      {
        "booking_url": "https://calendly.com/d/abcd-brv8/15-minute-meeting",
        "owner": "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
        "owner_type": "EventType"
      }
    ],
    "share_override": {
      "name": "15 Minute Meeting",
      "duration": 15,
      "duration_options": [
        1,
        13,
        15,
        720
      ],
      "period_type": "fixed",
      "start_date": "2019-01-02",
      "end_date": "2019-01-03",
      "max_booking_time": 300,
      "hide_location": true,
      "location_configurations": [
        {
          "location": "123 Abc St.",
          "additional_info": "Example additional info",
          "phone_number": "+1 888-888-8888",
          "position": 0,
          "kind": "physical"
        }
      ],
      "availability_rule": {
        "rules": [
          {
            "type": "wday",
            "wday": "friday",
            "intervals": [
              {
                "from": "07:00",
                "to": "11:00"
              }
            ]
          }
        ],
        "timezone": "America/New_York"
      }
    }
  }
}

Endpoint for our Customize Once and Share feature. This allows you to customize events for a specific invitee without needing to make an entirely new event type. This feature is only available for one-on-one event types. Note: Any parameter which is not provided in the request body will be copied from the target event type.

Required scopes

shares:write

Endpoint for our [Customize Once and Share](https://calendly.com/help/how-to-create-a-single-use-link) feature. This allows you to customize events for a specific invitee without needing to make an entirely new event type. ***This feature is only available for one-on-one event types.*** **Note: Any parameter which is not provided in the request body will be copied from the target event type.** <Info title="Required scopes"> > `shares:write` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Request

event_typestringRequiredformat: "uri"

namestringOptional<=55 characters

durationintegerOptional1-720

Must be one of the provided duration options. If duration options aren't provided then duration must be one of the duration options inherited from the event type.

duration_optionslist of integersOptional

A maximum of 4 unique options is allowed. Each option must be >= 1 and <= 720.

period_typeenumOptional

Allowed values:

start_datestringOptionalformat: "date"

is required when period_type is ‘fixed’ Format: YYYY-MM-DD

end_datestringOptionalformat: "date"

is required when period_type is ‘fixed’ Format: YYYY-MM-DD

max_booking_timeintegerOptional

is required when period_type is ‘moving’ or ‘available_moving’

hide_locationbooleanOptional

determines if a location is hidden until invitee books a spot, only respected when there is a single custom location configured

location_configurationslist of objectsOptional

availability_ruleobjectOptional

Response

Created

resourceobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error