# Create a schedule (/docs/api-reference/scheduling-schedules/create-scheduling-schedule)

A host's weekly hours and date overrides, in local time. The first one is the host's default.

`POST https://api.coss.com/v1/scheduling/hosts/{host}/schedules`

Authenticate with your API key as a bearer token (`Authorization: Bearer coss_test_…`). Responses are JSON with snake_case fields; errors are `{ error: { type, code, message, param?, issues?, request_id } }` (https://coss.com/docs/api-reference/errors.md).

## Path parameters

- `host` (string, required): The host's id or uid.

## Request body

- `name` (string, 1-100 characters)
- `time_zone` (string, 1-64 characters): Default: the host's.
- `is_default` (boolean)
- `rules` (object[], required, at most 50 items)
  - `days` (integer[], required, 1-7 items): Weekdays, with Sunday as 0.
  - `start` (string, required): A local time, `HH:MM`. `24:00` is the end of the day.
  - `end` (string, required): A local time, `HH:MM`. `24:00` is the end of the day.
- `overrides` (object[], at most 366 items): Replaces the schedule's overrides when given.
  - `date` (string, required): A local date in the schedule's time zone.
  - `ranges` (object[], required, at most 10 items): Replaces the weekly rules that day. Empty means unavailable all day.
    - `start` (string, required): A local time, `HH:MM`. `24:00` is the end of the day.
    - `end` (string, required): A local time, `HH:MM`. `24:00` is the end of the day.

## Example request

TypeScript (the `coss` package):

```ts
import { Coss } from "coss";

const coss = new Coss({
  apiKey: process.env.COSS_API_KEY,
  baseUrl: "https://api.coss.com",
});

const { data, error } = await coss.scheduling.schedules.create({
  value: "host_01kd2m9a0b1c2d3e4f5g6h7j8m",
}, {
  name: "Clinic hours",
  rules: [
    {
      days: [
        1,
        2,
        3,
        4,
        5,
      ],
      start: "09:00",
      end: "17:00",
    },
  ],
  overrides: [
    {
      date: "2027-12-24",
      ranges: [],
    },
  ],
});
```

HTTP:

```sh
curl -X POST "https://api.coss.com/v1/scheduling/hosts/host_01kd2m9a0b1c2d3e4f5g6h7j8m/schedules" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Clinic hours",
  "rules": [
    {
      "days": [
        1,
        2,
        3,
        4,
        5
      ],
      "start": "09:00",
      "end": "17:00"
    }
  ],
  "overrides": [
    {
      "date": "2027-12-24",
      "ranges": []
    }
  ]
}'
```

## Response 201

The schedule.

- `object` ("scheduling.schedule", required)
- `id` (string, required)
- `host` (string, required)
- `name` (string, required)
- `time_zone` (string, required)
- `is_default` (boolean, required)
- `rules` (object[], required)
  - `days` (number[], required)
  - `start` (string, required)
  - `end` (string, required)
- `overrides` (object[], required)
  - `date` (string, required)
  - `ranges` (object[], required)
    - `start` (string, required)
    - `end` (string, required)
- `created_at` (string, required)
- `updated_at` (string, required)

Example:

```json
{
  "object": "scheduling.schedule",
  "id": "sched_01kd2m9a0b1c2d3e4f5g6h7j8m",
  "host": "host_01kd2m9a0b1c2d3e4f5g6h7j8m",
  "name": "Clinic hours",
  "time_zone": "America/New_York",
  "is_default": true,
  "rules": [
    {
      "days": [
        1,
        2,
        3,
        4,
        5
      ],
      "start": "09:00",
      "end": "17:00"
    }
  ],
  "overrides": [
    {
      "date": "2027-12-24",
      "ranges": []
    }
  ],
  "created_at": "2027-01-01T10:00:00.000Z",
  "updated_at": "2027-01-01T10:00:00.000Z"
}
```

## Errors

- `400`: The body is not valid JSON (`invalid_json`). Also when the `Coss-Version` header names an unknown API version (`invalid_api_version`).
- `401`: The API key is missing, invalid, revoked or expired (`authentication_error`).
- `403`: The API key lacks the permission this endpoint needs (`permission_error`), or its organization is suspended (`organization_suspended`).
- `404`: Nothing with this id or uid exists in the environment (`not_found`).
- `415`: The body is not sent as `application/json` (`unsupported_media_type`).
- `422`: The request failed validation (`validation_error`, see `issues`), or can't be done: see `code`.
- `429`: Too many requests with this API key (`rate_limited`), or too many requests with invalid keys from this address (`too_many_failed_authentications`). Retry after `Retry-After` seconds. Successful responses carry `RateLimit-Limit`, `RateLimit-Remaining` and `RateLimit-Reset` (seconds until the limit is fully restored).
- `500`: Unexpected server error (`api_error` / `internal_error`).
- `503`: The API key could not be verified right now; retry (`service_unavailable`).