Create a tag

Creates a tag in the vocabulary of the account.

Tool

filmo_tags_create

Writetags:write

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_tags_create",
    "arguments": {
      "name": "Example"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "name": "Example",
      "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

If you also send entityId and entityType, it creates it AND assigns it to that entity in the same step, which is the normal case of an import. The two fields go together or not at all.

Arguments

namestringRequired

Tag name.

Limits: min length 1

entityIdstring

Entity to assign the tag to in the same step. Requires entityType.

entityTypestring

Type of that entity. Requires entityId.

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

idstring

Tag identifier.

namestring

Tag name.

assignedboolean

true if the tag was also assigned to the entity given in the body.

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.

Tags
Create a tag
Creates a tag in the vocabulary 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

Create a tag

Safe writes

Errors