Create Event Invitee (Scheduling API) | Calendly

import { CalendlyClient } from "calendly";
async function main() {
    const client = new CalendlyClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.scheduledEvents.createEventInvitee({
        eventType: "https://api.calendly.com/event_types/AAAAAAAAAAAAAAAA",
        startTime: new Date("2019-08-07T06:05:04.321123Z"),
        invitee: {
            email: "test@example.com",
            timezone: "America/New_York",
        },
    });
}
main();

{
  "resource": {
    "uri": "https://calendly.com/scheduled_events/AAAAAAAAAAAAAAAA/invitees/AAAAAAAAAAAAAAAA",
    "email": "test@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "name": "John Doe",
    "status": "active",
    "questions_and_answers": [
      {
        "question": "string",
        "answer": "string",
        "position": 1
      }
    ],
    "timezone": "string",
    "event": "https://api.calendly.com/scheduled_events/AAAAAAAAAAAAAAAA",
    "created_at": "2019-01-02T03:04:05.678123Z",
    "updated_at": "2019-08-07T06:05:04.321123Z",
    "tracking": {
      "utm_campaign": "string",
      "utm_source": "string",
      "utm_medium": "string",
      "utm_content": "string",
      "utm_term": "string",
      "salesforce_uuid": "string"
    },
    "text_reminder_number": "+1 404-555-1234",
    "rescheduled": true,
    "old_invitee": "string",
    "new_invitee": "string",
    "cancel_url": "string",
    "reschedule_url": "string",
    "routing_form_submission": "https://api.calendly.com/routing_form_submissions/AAAAAAAAAAAAAAAA",
    "payment": {
      "external_id": "string",
      "provider": "stripe",
      "amount": 1.1,
      "currency": "AUD",
      "terms": "sample terms of payment (up to 1,024 characters)",
      "successful": true
    },
    "no_show": {
      "uri": "string",
      "created_at": "2019-01-02T03:04:05.678123Z"
    },
    "reconfirmation": {
      "created_at": "2020-11-23T17:51:18.341657Z",
      "confirmed_at": "2020-11-23T17:51:18.341657Z"
    },
    "scheduling_method": "instant_book",
    "invitee_scheduled_by": "string",
    "cancellation": {
      "canceled_by": "string",
      "reason": "string",
      "canceler_type": "host",
      "created_at": "2019-01-02T03:04:05.678123Z"
    }
  }
}

Creates a new booking for an event invitee. Use this endpoint to book an invitee directly from your app without redirects, iframes, or Calendly-hosted UI.

Standard notifications, calendar invites, reschedules, and workflows run as if booked via the Calendly UI.

NOTE:

Access to this endpoint is limited to Calendly users on paid plans (Standard and above). Users on the Free plan will receive a 403 Forbidden response.

Required scopes

scheduled_events:write

Creates a new booking for an event invitee. Use this endpoint to book an invitee directly from your app without redirects, iframes, or Calendly-hosted UI. Standard notifications, calendar invites, reschedules, and workflows run as if booked via the Calendly UI. **NOTE:** * Access to this endpoint is limited to Calendly users on paid plans (Standard and above). Users on the Free plan will receive a 403 Forbidden response. <Info title="Required scopes"> > `scheduled_events:write` </Info>

Authentication

AuthorizationBearer

OAuth 2.0

AuthorizationBearer

Personal Access Token

Request

This endpoint expects an object.

event_typestringRequiredformat: "uri"

Canonical reference (unique identifier) for the event type being scheduled

start_timestringRequiredformat: "date-time"

The start time in UTC of the scheduled event

inviteeobjectRequired

locationobjectOptional

The polymorphic base type for an event location that Calendly supports.

Note:

Location.kind must be supplied if location is defined.
Location must match location specified on the EventType.
Do not pass the location object for an EventType with a round_robin pooling_type.

The polymorphic base type for an event location that Calendly supports. Note: - Location.kind must be supplied if location is defined. - Location must match location specified on the EventType. - Do not pass the location object for an EventType with a round_robin pooling_type.

questions_and_answerslist of objectsOptional

trackingobjectOptional

The UTM and Salesforce tracking parameters associated with an Invitee

event_guestslist of stringsOptional

Emails of invitee guests. Max 10.

Response

Created

resourceobject

An individual who has been invited to meet with a Calendly member

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error