---
title: "Update Schedule"
method: PATCH
path: "/schedules/{schedule_id}"
tags: ["Sequences"]
---

# Update Schedule

`PATCH /schedules/{schedule_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/schedules/{schedule_id}`
- Auth: HTTP bearer

Change a schedule's name, timezone or windows. Only what you send is written.

SHARED: this retimes EVERY sequence using the schedule, not one. `config`,
when sent, replaces the whole week - a day omitted from it stops sending.

## Path parameters

- `schedule_id` string, required: Schedule id, from `GET /schedules`.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- UpdateSendingScheduleRequest: Change a sending schedule. Mirrors `PatchScheduleParams`.
  - `name` string, nullable
  - `description` string, nullable
  - `config` SendingWeek: The weekly window. A day left out is a day nothing is sent.
    - `monday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `tuesday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `wednesday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `thursday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `friday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `saturday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
    - `sunday` SendingWindow: One day's sending window. `start` must be EARLIER than `end`. Overnight windows are not supported - model them as two days. The app rejects an inverted or zero-length window, and so does this.
      - `start` string, required: `HH:MM`, 24-hour.
      - `end` string, required: `HH:MM`, 24-hour.
  - `timezone` string, nullable

## Response `200`

Successful Response

- ApiResponseSequencerPayload
  - `data` SequencerPayload, required: An open envelope around one sequencer record. Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)
