---
title: "Edit playbook metadata"
method: PUT
path: "/workspace/{ws_id}/playbooks/{id}/edit"
tags: ["Workflows"]
---

# Edit playbook metadata

`PUT /workspace/{ws_id}/playbooks/{id}/edit`

Updates the name, description, tags, and runner of the playbook with the given ID. Updating the runner requires the ViewAction permission on RunnerObject.

## Path parameters

- `ws_id` string, required
- `id` string, required

## Request body

- ApiRequestsEditPlaybookInput
  - `active` boolean
  - `analyst_copilot_workflow` boolean
  - `custom_timeout` integer
  - `desc` string
  - `icon` string
  - `is_request` boolean
  - `max_concurrency_level` integer
  - `name` string
  - `notification_emails` string
  - `playbook_to_run_on_error` string
  - `preferred_engine_version` string — The preferred workflow engine version
  - `runner` string
  - `step_transition_limit` integer
  - `tags` string[]

## Response `200`

Updated playbook metadata

- ApiRequestsEditPlaybookInput
  - `active` boolean
  - `analyst_copilot_workflow` boolean
  - `custom_timeout` integer
  - `desc` string
  - `icon` string
  - `is_request` boolean
  - `max_concurrency_level` integer
  - `name` string
  - `notification_emails` string
  - `playbook_to_run_on_error` string
  - `preferred_engine_version` string — The preferred workflow engine version
  - `runner` string
  - `step_transition_limit` integer
  - `tags` string[]

## Other responses

- `400` — Invalid request body or invalid field value
- `401` — Unauthorized
- `403` — Forbidden — insufficient permissions
- `404` — Playbook not found
- `500` — Internal server error

---

[API](https://skmtc.net/blinkops/apis/blink-rest-api.md) · [All operations](https://skmtc.net/blinkops/apis/blink-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blinkops/blink-rest-api/revisions/f043409736b2/schema)