coss.comdocs

Create a host

POST
/v1/scheduling/hosts

A person who can be booked: one of your users, such as a doctor or a tutor.

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

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
uid?string

Your own id for this host, unique in the environment.

Length1 <= length <= 255
name*string
Length1 <= length <= 100
email?string

Where this host's notifications go. Not an identity, and need not be unique.

Formatemail
Lengthlength <= 320
time_zone*string

An IANA time zone name.

Length1 <= length <= 64
attributes?

What pools filter hosts by, such as { "licensed_in": ["CA", "NY"], "language": "es" }.

metadata?

Your own key-value pairs. Don't put sensitive data here.

Response Body

The host.

application/json
  1. response
object*"scheduling.host"
Value in"scheduling.host"
id*string
uid*string|null
name*string
email*string|null
time_zone*string
attributes*
metadata*
status*string
Value in"active""disabled"
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.hosts.create({  uid: "doctor_482",  name: "Dr. Ana Reyes",  email: "ana@example.com",  time_zone: "America/New_York",  attributes: {    licensed_in: [      "NY",      "NJ",    ],  },});
{  "object": "scheduling.host",  "id": "host_01kd2m9a0b1c2d3e4f5g6h7j8m",  "uid": "doctor_482",  "name": "Dr. Ana Reyes",  "email": "ana@example.com",  "time_zone": "America/New_York",  "attributes": {    "licensed_in": [      "NY",      "NJ"    ]  },  "metadata": {},  "status": "active",  "created_at": "2027-01-01T10:00:00.000Z",  "updated_at": "2027-01-01T10:00:00.000Z"}