Update settings

PATCH
/v1/scheduling/settings

Changes what's given.

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
allowed_origins?array<>
Itemsitems <= 10
brand_name?|
Length1 <= length <= 100
accent_color?|
Match^#[0-9a-fA-F]{6}$
email_from?|
Formatemail
Lengthlength <= 320
sms_from?|
Match^\+[1-9]\d{6,14}$
calendar_failure_mode?string
Value in"hide""last_known"
notifications?|null

Response Body

The settings.

application/json
  1. response
object*"scheduling.settings"
Value in"scheduling.settings"
allowed_origins*array<string>

Sites allowed to embed coss.com's hosted pages and call the client API.

brand_name*string|null
accent_color*string|null
email_from*|

Sender of booking emails, on a verified domain.

sms_from*|

Your approved number for SMS reminders. Without one, no SMS is sent.

calendar_failure_mode*string

When a host's calendar can't be read: stop offering them, or keep offering their last known times and flag those bookings as unverified.

Value in"hide""last_known"
notifications*|

Per event, overriding the defaults.

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.settings.update({  brand_name: "Acme Health",});
{  "object": "scheduling.settings",  "allowed_origins": [    "https://app.example.com"  ],  "brand_name": "Acme Health",  "accent_color": null,  "email_from": "appointments@example.com",  "sms_from": null,  "calendar_failure_mode": "hide",  "notifications": {    "reminder": {      "sms_attendee": true    }  }}