Create a task tree hold
POST
/api/issues/{id}/tree-holdsPersonal API keyConsole session
Create a task tree hold.
Board-only. An agent cannot pause, cancel or resume a task tree, and this denial is final for agents. A person pauses the parent task and all of its subtasks on the organization-prefixed task page /{prefix}/issues/{identifier}: More task actions, then Pause subtree. The person resumes it later on the same page with Resume subtree. Link that task page. Moving tasks to backlog or changing assignees is not a tree pause.
Authorization
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.
Path parameters
idstringRequiredThe task's id.
Request body
application/json · required
modestringRequired
one of: "pause", "resume", "cancel", "restore"reasonstring | nullOptional
1–1000 charactersreleasePolicyobject | nullOptional
releasePolicy.strategystringOptional
one of: "manual", "after_active_runs_finish"releasePolicy.notestring | nullOptional
1–500 charactersmetadataobject | nullOptional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.