# Create booking (Cal.com)

Operation ID: `connectors.calCreateBooking`

POST /v2/bookings. Raises on validation or HTTP errors.

## Public method

`createBooking`

Signature: `connectors.cal.createClient(config).createBooking(body)`

Return type: `Promise<CalCreateBookingResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/cal/create-booking`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`CalCreateBookingRequest`](../models/CalCreateBookingRequest.md) | Yes |  |  |  | No |  |

Request model: [`CalCreateBookingRequest`](../models/CalCreateBookingRequest.md)

## Request example

```json
{
  "api_key": "example-api-key",
  "booking": {
    "vendorField": "vendor-defined value"
  },
  "default_event_type_id": 2883016,
  "mode": "sandbox"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`CalBookingData`](../models/CalBookingData.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "absent_host": true,
  "attendees": [],
  "booking_fields_responses": {},
  "cancellation_reason": "example-cancellation-reason",
  "cancelled_by_email": "patient@example.com",
  "created_at": "example-created-at",
  "description": "example-description",
  "duration": 1,
  "end": "example-end",
  "event_type": {},
  "event_type_id": 1,
  "guests": [
    "example-guests"
  ],
  "hosts": [],
  "id": 1,
  "location": "example-location",
  "meeting_url": "https://example.com/resource",
  "metadata": {
    "vendorField": "vendor-defined value"
  },
  "rating": 1,
  "rescheduled_by_email": "patient@example.com",
  "rescheduled_from_uid": "example-rescheduled-from-uid",
  "rescheduling_reason": "example-rescheduling-reason",
  "start": "example-start",
  "status": "example-status",
  "title": "example-title",
  "uid": "example-uid",
  "updated_at": "example-updated-at"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { CalCreateBookingRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "booking": {
    "vendorField": "vendor-defined value"
  },
  "default_event_type_id": 2883016,
  "mode": "sandbox"
};

const result = await connectors.cal.createClient(config).createBooking(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","booking":{"vendorField":"vendor-defined value"},"default_event_type_id":2883016,"mode":"sandbox"}' \
  'https://dev-api-connectors.health.cloud/connectors/cal/create-booking'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.