Assign a tag to an entity

Attaches an existing tag to an entity of the account.

Tool

filmo_tags_assign

Writetags:write

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_tags_assign",
    "arguments": {
      "tagId": "tag_8f2a1c",
      "entityId": "enti_8f2a1c",
      "entityType": "item"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "tagId": "tag_8f2a1c",
      "entityId": "enti_8f2a1c",
      "assigned": true
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

The tag goes in the path and the entity in the body.

Arguments

tagIdstringRequired

Tag identifier.

Limits: min length 1

entityIdstringRequired

Entity the tag is assigned to or removed from.

Limits: min length 1

entityTypestringRequired

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

idempotencyKeystring

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

tagIdstring

Tag identifier.

entityIdstring

Entity identifier.

assignedboolean

true after assigning, false after removing.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs POST /api/v1/tags/{tagId}/assignments.

Tags
Assign a tag to an entity
Attaches an existing tag to an entity of the account.
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: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Assign a tag to an entity

Safe writes

Errors