---
title: "Update a playbook run"
method: PATCH
path: "/plugins/playbooks/api/v0/runs/{id}"
tags: ["PlaybookRuns"]
---

# Update a playbook run

`PATCH /plugins/playbooks/api/v0/runs/{id}`

## Path parameters

- `id` string, required

## Request body

- object
  - `name` string — The new name of the playbook run. Must not be empty.
  - `summary` string — The new summary of the playbook run. Can be empty to clear the summary.

## Response `200`

Playbook run successfully updated.

## Other responses

- `400` — The request is malformed.
- `500` — There was an internal error in the server.

## Changes

> 47 revisions in range; 18 could not be searched.

- **2026-01-22** `7cc35d281cdf` — 1 info
  - added the new optional request property `summary`
- **2025-12-16** `1e4ca3a6a157` — 1 warning, 1 info
  - removed the request property `active_stage`
  - added the new optional request property `name`
- **2023-06-19** `148981c0ea86` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/mattermost/apis/playbooks-api/changes/plugins/playbooks/api/v0/runs/:id/patch.md)

---

[API](https://skmtc.dev/mattermost/apis/playbooks-api.md) · [All operations](https://skmtc.dev/mattermost/apis/playbooks-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mattermost/playbooks-api/revisions/2acd884508c4/schema)