# Full Cal <-> Athena availability sync; returns a CalSyncResult dict

Operation ID: `connectors.calSyncWithAthena`

Full Cal <-> Athena availability sync; returns a CalSyncResult dict. Never raises: any failure is reported on the result's ``error`` field with ``success: false``.

## Public method

`syncWithAthena`

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

Return type: `Promise<CalSyncWithAthenaResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/cal/sync-with-athena`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "api_key": "example-api-key",
  "athena_slots": [
    {
      "vendorField": "vendor-defined value"
    }
  ],
  "default_event_type_id": 2883016,
  "end_date": {
    "vendorField": "vendor-defined value"
  },
  "event_type_id": 1,
  "mode": "sandbox",
  "start_date": {
    "vendorField": "vendor-defined value"
  }
}
```

## Success responses

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

## Success response examples

### 200

```json
{
  "athena_slots": 0,
  "athena_telehealth_slots": 0,
  "cal_slots_after_update": 0,
  "cal_slots_before_update": 0,
  "end_date": "example-end-date",
  "error": "example-error",
  "start_date": "example-start-date",
  "success": false,
  "sync_datetime": "example-sync-datetime"
}
```

## 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 { CalSyncWithAthenaRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "athena_slots": [
    {
      "vendorField": "vendor-defined value"
    }
  ],
  "default_event_type_id": 2883016,
  "end_date": {
    "vendorField": "vendor-defined value"
  },
  "event_type_id": 1,
  "mode": "sandbox",
  "start_date": {
    "vendorField": "vendor-defined value"
  }
};

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

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","athena_slots":[{"vendorField":"vendor-defined value"}],"default_event_type_id":2883016,"end_date":{"vendorField":"vendor-defined value"},"event_type_id":1,"mode":"sandbox","start_date":{"vendorField":"vendor-defined value"}}' \
  'https://dev-api-connectors.health.cloud/connectors/cal/sync-with-athena'
```

## 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.