v46

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-174421106.5 KB
PlaybookRuns

Update an item of a playbook run's checklist

Update the title, slash command, and description of an item in one of the playbook run's checklists.

put/plugins/playbooks/api/v0/runs/{id}/checklists/{checklist}/item/{item}

Path parameters

idstring required

ID of the playbook run whose checklist will be modified.

checklistinteger required

Zero-based index of the checklist to modify.

iteminteger required

Zero-based index of the item to modify.

Request body

titlestring required

The new title of the item.

commandstring required

The new slash command of the item.

descriptionstring

The new description of the item, formatted with Markdown.

Example request

{
  "title": "Gather information from server's logs.",
  "command": "/jira update ticket",
  "description": "Ask the customer for more information in [Zendesk](https://www.zendesk.com/)."
}

Response

Item updated.