Create a schedule

POST
/v1/scheduling/hosts/{host}/schedules

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

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

host*string

The host's id or uid.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Request Body

application/json
  1. body
name?string

A label for the schedule. Default on creation: Default.

Length1 <= length <= 100
time_zone?string

Default: the host's.

Length1 <= length <= 64
is_default?boolean

true makes this the host's default schedule, in place of the current one. A host's first schedule is their default anyway.

rules*array<>

Weekly hours in local time. A range can't cross midnight: use two.

Itemsitems <= 50
overrides?array<>

Replaces the schedule's overrides when given.

Itemsitems <= 366

Response Body

The schedule.

application/json
  1. response
object*"scheduling.schedule"
Value in"scheduling.schedule"
id*string
host*string

The id of the host this schedule belongs to.

name*string

A label for the schedule. Default when none was given.

time_zone*string

The IANA time zone its rules and overrides are local to.

is_default*boolean

Whether this is the host's default schedule, used by event types that don't name one. A host's first schedule always is.

rules*array<>

Weekly hours in local time, unchanged across daylight saving.

overrides*array<>

Dates whose hours replace the weekly rules.

created_at*string
updated_at*string
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: [],    },  ],});
{  "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"}