# Update a host (/docs/api-reference/scheduling-hosts/update-scheduling-host)

Changes what's given. A `disabled` host keeps its bookings but gets no new ones.

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

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

- `uid` (string | null, 1-255 characters): Your own id for this host, unique in the environment.
- `name` (string, 1-100 characters)
- `email` (string | null, email, at most 320 characters)
- `time_zone` (string, 1-64 characters): An IANA time zone name.
- `attributes` (map of string | string[]): What pools filter hosts by, such as `{ "licensed_in": ["CA", "NY"], "language": "es" }`.
- `metadata` (map of string): Your own key-value pairs. Don't put sensitive data here.
- `status` ("active" | "disabled"): A `disabled` host isn't offered. Its existing bookings stay.

## 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.hosts.update({
  value: "host_01kd2m9a0b1c2d3e4f5g6h7j8m",
}, {
  status: "disabled",
});
```

HTTP:

```sh
curl -X PATCH "https://api.coss.com/v1/scheduling/hosts/host_01kd2m9a0b1c2d3e4f5g6h7j8m" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "disabled"
}'
```

## Response 200

The host.

- `object` ("scheduling.host", required)
- `id` (string, required)
- `uid` (string | null, required)
- `name` (string, required)
- `email` (string | null, required)
- `time_zone` (string, required)
- `attributes` (map of string | string[], required)
- `metadata` (map of string, required)
- `status` ("active" | "disabled", required)
- `created_at` (string, required)
- `updated_at` (string, required)

Example:

```json
{
  "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"
}
```

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