Release a task tree hold

POST/api/issues/{id}/tree-holds/{holdId}/release
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Release a task tree hold.

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.
holdIdstringRequiredThe hold's id.

Request body

application/json · required

reasonstring | nullOptional1–1000 characters
releasePolicyobject | nullOptional
releasePolicy.strategystringOptionalone of: "manual", "after_active_runs_finish"
releasePolicy.notestring | nullOptional1–500 characters
metadataobject | nullOptional

Responses

200SuccessThe request worked; the body holds the result.
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.

Tasks