v46

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

Update the state of an item

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

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

new_state'' | 'in_progress' | 'closed' required

The new state of the item.

Example request

{
  "new_state": "closed"
}

Response

Item's state successfully updated.