v1Resources/Approvals/putSet a task's owner
Set a task's owner
Makes one person the owner of a task, replacing whoever owned it before. Each removed owner is kept in the task's history, and both the previous and the new owner get a notice. Use GET /api/v1/work-management/owners to find who is eligible. A client user can own a task only when the task has a client, and only a client user of that client. Changing the owner while the task waits for approval returns 409, so withdraw the approval request first. A task outside the key's client access returns 403. Retries with the same idempotencyKey and body return the first result with replayed set to true. If Tasks & Approvals isn't turned on for your workspace, this returns 404.
put
approvals:write/api/v1/work-management/tasks/{id}/ownerQuery parameters
idstringrequired
The task's id, a UUID. Any other value returns 404.
Request body
idempotencyKeystringrequired
A unique string you choose, 8 to 200 characters. Reuse it only to retry the same request.
userIdstringrequired
The id of the new owner, from GET /api/v1/work-management/owners.
ownerTypestring (user | client_user)optional
Whether the owner is an agency teammate (user) or a client user (client_user). Defaults to user.
notestringoptional
An optional note for the new owner, up to 500 characters.
Response
okbooleanoptional
Always true on a successful response.
dataobjectoptional
keystringoptional
The task's key, in the form task:<id>.
assignmentIdstringoptional
The id of the owner assignment.
replacedintegeroptional
How many previous owners were removed. 0 when the person already owned the task.
replayedbooleanoptional
true when this response repeats an earlier request with the same idempotencyKey, so nothing new was saved.
Errors
400Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
401Missing, invalid, expired, or revoked API key.
403Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
404Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
409Tasks & Approvals errors come back as ok: false with an error object holding code, message, retryable and details. Errors from the API key check itself (a missing or invalid key, a missing scope, the rate limit) use the standard error shape, where error is a string.
429Too many requests. Retry after the number of seconds in the Retry-After header.
500The request couldn't be completed because of a problem on our side.
put/api/v1/work-management/tasks/{id}/owner
Your API key
id *
Request body*
{}