Notes

Write a note on an entity

Leaves a record on an entity of the account: why an order was rejected, how a repair is going.

Tool

filmo_notes_create

Writenotes:write

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_notes_create",
    "arguments": {
      "relatedDocumentType": "item",
      "relatedDocumentId": "rela_8f2a1c",
      "content": "<content>"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "content": "<content>",
      "relatedDocumentType": "<relatedDocumentType>",
      "relatedDocumentId": "rela_8f2a1c",
      "subRelatedDocumentType": "<subRelatedDocumentType>",
      "subRelatedDocumentId": "subr_8f2a1c",
      "subRelatedDocumentCode": "<subRelatedDocumentCode>",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z"
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Server annotation

A note with mentionedUserIds notifies those Filmo users.

With subRelatedDocumentType and subRelatedDocumentId the note goes on a specific physical unit and not on the whole item. mentionedUserIds notifies those Filmo users. The notes of an entity are read with GET /api/v1/notes.

Arguments

relatedDocumentTypestringRequired

Type of the entity the note is attached to.

Available options: item, contact, order, space, kit, vehicle, staff, service, collection, project, repairTicket, purchaseOrder, supplierInvoice

relatedDocumentIdstringRequired

Identifier of that entity.

Limits: min length 1

contentstringRequired

Note text.

Limits: min length 1

subRelatedDocumentTypestring

When the note is about a specific physical unit of the item.

subRelatedDocumentIdstring

Identifier of that physical unit. Requires subRelatedDocumentType.

subRelatedDocumentCodestring

Code of the unit, so that it can be read in the note without resolving the id.

mentionedUserIdsstring[]

Filmo users to notify. Each one receives a notification.

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

Unique identifier of the note.

contentstring

Note text.

relatedDocumentTypestring | null

Type of the entity the note is attached to; null if it is not attached.

relatedDocumentIdstring | null

Identifier of that entity; null if the note is not attached.

subRelatedDocumentTypestring | null

Type of the sub-entity; null if not applicable.

subRelatedDocumentIdstring | null

Identifier of the sub-entity; null if not applicable.

subRelatedDocumentCodestring | null

Human-readable code of the sub-entity; null if not applicable.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

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

Sample prompts

Leave a note on this order saying the customer will pick up at the north door.

The same operation by REST

This tool runs POST /api/v1/notes.

Notes
Write a note on an entity
Leaves a record on an entity of the account: why an order was rejected, how a repair is going.
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

Sample prompts

The same operation by REST

Related pages

Write a note on an entity

Safe writes

Errors