PlaybookRuns

Update a playbook run

patch/plugins/playbooks/api/v0/runs/{id}

Request

Base URL
http://localhost:8065/plugins/playbooks/api/v0
Auth
HTTP bearer
TypeScript
https://skmtc.dev/mattermost/apis/playbooks-api/docs/plugins/playbooks/api/v0/runs/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Example:mx3xyzdojfgyfdx8sc8of1gdme

ID of the playbook run to retrieve.

namestring

The new name of the playbook run. Must not be empty.

summarystring

The new summary of the playbook run. Can be empty to clear the summary.

{
  "name": "Updated Server Down Incident",
  "summary": "## Incident Summary\n\nResolved the server outage."
}

Playbook run successfully updated.

Jan 22, 20267cc35d281cdf Revision changes
- info
  added the new optional request property
Dec 16, 20251e4ca3a6a157 Revision changes
- warning
  removed the request property
- info
  added the new optional request property