---
title: "Update a runbook"
method: PATCH
path: "/runbooks/{runbookId}"
tags: ["runbooks"]
---

# Update a runbook

`PATCH /runbooks/{runbookId}`

Updates a runbook

## Path parameters

- `runbookId` string, required — Runbook ID

## Headers

- `Authorization` string, required
- `X-Disable-Hooks` 'true', required

## Request body

- TypeRunbooksUpdateRunbookRequest
  - `name` string — The name of the Runbook.
  - `status` 'CREATED' | 'RECORDING' | 'EXECUTING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'CANCELED'
  - `config` TypeRunbooksRunbookConfig
    - `sourceSheetIds` string[], required — The ids of the sourceSheets to transform
    - `destinationSheetIds` string[], required — The id of the destinationSheet to transform

## Response `200`

Response with status 200

- TypeRunbooksRunbookResponse
  - `data` TypeRunbooksRunbook, required — Runbook
    - `id` string, required — Runbook ID
    - `accountId` string, required — Account ID
    - `appId` string, required — App ID
    - `environmentId` string, required — Environment ID
    - `spaceId` string, required — Space ID
    - `name` string, required — The name of the Runbook.
    - `config` TypeRunbooksRunbookConfig, required
      - `sourceSheetIds` string[], required — The ids of the sourceSheets to transform
      - `destinationSheetIds` string[], required — The id of the destinationSheet to transform
    - `status` 'CREATED' | 'RECORDING' | 'EXECUTING' | 'WAITING' | 'COMPLETED' | 'FAILED' | 'CANCELED', required
    - `type` 'SHEET_TOOL' | 'PREPROCESSING', required
    - `createdBy` string, required — The entity which created the Runbook.
    - `createdAt` string, date-time, required — Date the sheet was created
    - `updatedAt` string, date-time, required — Date the sheet was last updated

## Other responses

- `400` — Error response with status 400
- `404` — Error response with status 404

---

[API](https://skmtc.net/flatfile/apis/api-reference.md) · [All operations](https://skmtc.net/flatfile/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flatfile/api-reference/revisions/9d3a9979cd96/schema)