---
title: "Create Schedule"
method: POST
path: "/schedules"
tags: ["Schedules"]
---

# Create Schedule

`POST /schedules`

## Request body

- CreateScheduleRequestData
  - `name` string, required
  - `message` string, required
  - `scheduled_at` string, date-time, required
  - `completed_at` string, date-time, required
  - `status` 0 | 1 | 2
  - `components` ScheduleComponentRequestData[], nullable
    - `id` integer, required
    - `status` 1 | 2 | 3 | 4 | 5, required

## Response `200`

`Schedule`

- object
  - `data` Schedule, required
    - `id` string, required
    - `type` 'schedules', required
    - `attributes` object
      - `id` integer, required
      - `name` string, required
      - `message` string, nullable, required
      - `status` object, required
        - `human` string, required
        - `value` string, required
      - `scheduled` object, required
        - `human` string, required
        - `string` string, required
      - `completed` object, required
        - `human` string, required
        - `string` string, required
      - `created` object, required
        - `human` string, required
        - `string` string, required
      - `updated` object, required
        - `human` string, required
        - `string` string, required
    - `relationships` object
      - `components` object
        - `data` Component[], required
          - `id` string, required
          - `type` 'components', required
          - `attributes` object
            - `id` integer, required
            - `name` string, required
            - `description` string, nullable, required
            - `link` string, nullable, required
            - `order` integer, nullable, required
            - `status` object, required
              - …
            - `enabled` boolean, required
            - `meta` unknown[], nullable, required
              - …
            - `created` object, required
              - …
            - `updated` object, required
              - …
          - `relationships` object
            - `group` object
              - …
            - `incidents` object
              - …
      - `updates` object
        - `data` Update[], required
          - `id` string, required
          - `type` 'updates', required
          - `attributes` object
            - `id` integer, required
            - `updateable_id` integer, required
            - `updateable_type` string, required
            - `message` string, required
            - `status` object
              - …
            - `created` object, required
              - …
            - `updated` object, required
              - …

## Other responses

- `401` — Unauthenticated
- `422` — Validation error

## Changes

- **2025-06-02** `9ad32c73fe39` — 20 breaking, 3 warning
  - the response property `data/attributes/message` became nullable for the status `200`
  - the response property `data/relationships/components/data/items/attributes/description` became nullable for the status `200`
  - the response property `data/relationships/components/data/items/attributes/link` became nullable for the status `200`
  - the response property `data/relationships/components/data/items/attributes/meta` became nullable for the status `200`
  - …19 more
- **2025-05-29** `87e56b3f8fd7` — 3 warning
  - removed the optional property `data/relationships/components/data/items/relationships/group/data/attributes` from the response with the `200` status
  - removed the optional property `data/relationships/components/data/items/relationships/group/data/relationships` from the response with the `200` status
  - removed the optional property `data/relationships/components/data/items/relationships/incidents/data/items/relationships/user/data/attributes` from the response with the `200` status

[Change history](https://skmtc.dev/cachethq/apis/cachet/changes/schedules/post.md)

---

[API](https://skmtc.dev/cachethq/apis/cachet.md) · [All operations](https://skmtc.dev/cachethq/apis/cachet/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cachethq/cachet/revisions/9ad32c73fe39/schema)