v1Resources/Approvals/postAdd or remove approvals tags
Add or remove approvals tags
Approvals tags organize items in Inbox → Approvals and are separate from Social Inbox tags. Tag names and colors are shared across the workspace; usage counts are not returned. Tags are added or removed only on items the token creator can currently see, and an item it can’t see is skipped, never tagged. Tagging is not a decision and grants no access.
post
approvals:write/api/v1/work-management/approval-tags/applyRequest body
itemKeysarray of stringrequired
1 to 200 items to change, each as task:<id> or approval:<id>. Repeats are counted once.
addarray of stringoptional
Ids of approvals tags to add. Unknown or archived tags are ignored. add and remove together hold 1 to 50 ids.
removearray of stringoptional
Ids of approvals tags to remove. Unknown tags are ignored.
Response
okbooleanoptional
Always true on a successful response.
updatedintegeroptional
How many items the change was applied to. Repeating a call changes nothing more: an item keeps a tag once.
skippedarray of objectoptional
Items left unchanged because you can't see them, each with the code a write would get, such as not_found or forbidden.
itemKeystringoptional
The task's key, in the form task:<id>.
codestringoptional
What went wrong: invalid (400), forbidden (403), not_found (404), stale, conflict or blocked (409), or internal (500).
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/work-management/approval-tags/apply
Your API key
Request body*
{}