---
title: "Update Work Routine"
method: PATCH
path: "/work/routines/{routine_id}"
tags: ["Work"]
---

# Update Work Routine

`PATCH /work/routines/{routine_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/routines/{routine_id}`
- Auth: HTTP bearer

Change one routine.

Only somebody who can read the routine's delivery conversation may change
it, and re-pointing ``deliveryConversationId`` is a second grant: the NEW
conversation must be readable too. Omitted fields keep their stored value.

## Path parameters

- `routine_id` string, uuid, required: Routine id

## Headers

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

## Request body

- WorkRoutinePatchRequest: Changes to one routine. Omitted fields keep their stored value.
  - `agentId` string, nullable: Agent that runs the routine
  - `title` string, nullable: What the routine is called
  - `instruction` string, nullable: What the agent is asked to do each run
  - `deliveryConversationId` string, nullable: Re-point delivery; the new conversation must also be readable
  - `weekdays` integer[], nullable: Days to run on (0-6)
  - `localTime` string, nullable: Local run time `HH:MM`
  - `timezone` string, nullable: IANA timezone the local time is read in
  - `enabled` boolean, nullable: Turn the routine on or off
  - `triggerKind` string, nullable: `schedule` or `event`
  - `trigger` object, nullable: Trigger config, for `event` routines
  - `eventPolicy` object, nullable: Optional event-handling policy

## Response `200`

Successful Response

- ApiResponseWorkRoutineEnvelope
  - `data` WorkRoutineEnvelope, required: One routine, as the create and update operations return it.
    - `routine` WorkRoutine, required: One scheduled or event-triggered Work routine.
      - `id` string, nullable: Routine id
      - `title` string, nullable: Routine title
      - `instruction` string, nullable: What the agent is asked to do each run
      - `agentId` string, nullable: Agent that runs the routine
      - `deliveryConversationId` string, nullable: Conversation the routine posts into
      - `enabled` boolean, nullable: Whether the routine is active
      - `triggerKind` string, nullable: `schedule` or `event`
      - `weekdays` integer[], nullable: Schedule weekdays (0-6), for `schedule` routines
      - `localTime` string, nullable: Local run time, for `schedule` routines
      - `timezone` string, nullable: IANA timezone the local time is read in
      - `lastRunAt` string, nullable: When the routine last ran
      - `lastStatus` string, nullable: How the last run ended
  - `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)