# Cancel a recurring series (/docs/api-reference/scheduling-series/cancel-scheduling-series)

Cancels the occurrences from `from_index` on, or all of them.

`POST https://api.coss.com/v1/scheduling/series/{id}/cancel`

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

- `id` (string, required): The series' id.

## Request body

- `from_index` (integer, at least 0, default 0): Cancel this occurrence and those after it. Default: all of them.

## 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.series.cancel("series_01kd2m9a0b1c2d3e4f5g6h7j8m", {
  from_index: 4,
});
```

HTTP:

```sh
curl -X POST "https://api.coss.com/v1/scheduling/series/series_01kd2m9a0b1c2d3e4f5g6h7j8m/cancel" \
  -H "Authorization: Bearer $COSS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "from_index": 4
}'
```

## Response 200

The cancelled bookings.

- `object` ("list", required)
- `data` (object[], required)
  - `object` ("scheduling.booking", required)
  - `id` (string, required)
  - `event_type` (string, required)
  - `status` ("held" | "pending_approval" | "confirmed" | "cancelled" | "declined", required)
  - `title` (string, required)
  - `start` (string, required)
  - `end` (string, required)
  - `hosts` (string[], required)
  - `attendees` (object[], required)
    - `id` (string, required)
    - `uid` (string | null, required)
    - `name` (string | null, required)
    - `email` (string | null, required)
    - `phone` (string | null, required)
    - `time_zone` (string, required)
    - `locale` (string | null, required)
    - `answers` (map of string | string[]): Only when retrieving one booking.
  - `location` (object, required)
    - One of (1):
      - `type` ("link", required)
      - `url` (string | null, uri, at most 2000 characters, default null)
    - One of (2):
      - `type` ("phone", required)
      - `number` (string | null, at most 32 characters, default null)
    - One of (3):
      - `type` ("in_person", required)
      - `address` (string | null, at most 500 characters, default null)
    - One of (4):
      - `type` ("google_meet", required)
    - One of (5):
      - `type` ("microsoft_teams", required)
  - `hold_expires_at` (string | null, required)
  - `approval_expires_at` (string | null, required)
  - `series` (string | null, required)
  - `series_index` (number | null, required)
  - `group_session` (string | null, required)
  - `calendar_unverified` (boolean, required)
  - `external_conflict_at` (string | null, required)
  - `no_show_at` (string | null, required)
  - `cancelled_at` (string | null, required)
  - `metadata` (map of string, required)
  - `created_at` (string, required)
  - `updated_at` (string, required)
- `has_more` (false, required)

Example:

```json
{
  "object": "list",
  "data": [
    {
      "object": "scheduling.booking",
      "id": "book_01kd2m9a0b1c2d3e4f5g6h7j8m",
      "event_type": "evtype_01kd2m9a0b1c2d3e4f5g6h7j8m",
      "status": "confirmed",
      "title": "Initial consultation",
      "start": "2027-01-04T15:00:00.000Z",
      "end": "2027-01-04T15:30:00.000Z",
      "hosts": [
        "host_01kd2m9a0b1c2d3e4f5g6h7j8m"
      ],
      "attendees": [
        {
          "id": "attn_01kd2m9a0b1c2d3e4f5g6h7j8m",
          "uid": "patient_77",
          "name": "Sam Lee",
          "email": "sam@example.com",
          "phone": null,
          "time_zone": "UTC",
          "locale": null
        }
      ],
      "location": null,
      "hold_expires_at": null,
      "approval_expires_at": null,
      "series": null,
      "series_index": null,
      "group_session": null,
      "calendar_unverified": false,
      "external_conflict_at": null,
      "no_show_at": null,
      "cancelled_at": null,
      "metadata": {},
      "created_at": "2027-01-01T10:00:00.000Z",
      "updated_at": "2027-01-01T10:00:00.000Z"
    }
  ],
  "has_more": false
}
```

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