Tags
Remove a tag from an entity
Undoes the link between a tag and an entity.
tags:writetags:write- 120/min
- Server annotation: Destructive
- Server annotation: Idempotent
- Requires human confirmation
Result
generated from the schema
Requires human confirmation
Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone.
It does NOT delete the tag from the vocabulary of the account: it still exists and remains assigned to everything else.
Arguments
Tag identifier.
Limits: min length 1
Entity the tag is assigned to or removed from.
Limits: min length 1
Type of that entity.
Available options: item, contact, order, space, project, kit, serializedItem, vehicle, staff, service, purchaseOrder, incident, repairTicket, opportunity, contract, invoice, creditNote, salesReceipt, simpleCreditNote, supplierInvoice
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Tag identifier.
Entity identifier.
true after assigning, false after removing.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs DELETE /api/v1/tags/{tagId}/assignments.
Related pages
Link to this section: Related pagesTags
Remove a tag from an entity
Undoes the link between a tag and an entity.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?