*REST API › Endpoint reference › Platform › 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.

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`](https://docs.filmo.io/rest-api/endpoint-reference/notes/list-the-notes-of-an-entity).

`POST /api/v1/notes` — scope `notes:write`

Scope: `notes:write` · 120/min · Idempotency-Key · MCP: `filmo_notes_create`

## Authorizations

Bearer API key with the scope below. `notes:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |

## Body

Body schema: `NoteCreateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedDocumentType` | string | Yes | Type of the entity the note is attached to. `item`, `contact`, `order`, `space`, `kit`, `vehicle`, `staff`, `service`, `collection`, `project`, `repairTicket`, `purchaseOrder`, `supplierInvoice` |
| `relatedDocumentId` | string | Yes | Identifier of that entity. |
| `content` | string | Yes | Note text. |
| `subRelatedDocumentType` | string | No | When the note is about a specific physical unit of the item. `serializedItem` |
| `subRelatedDocumentId` | string | No | Identifier of that physical unit. Requires `subRelatedDocumentType`. |
| `subRelatedDocumentCode` | string | No | Code of the unit, so that it can be read in the note without resolving the id. |
| `mentionedUserIds` | string[] | No | Filmo users to notify. Each one receives a notification. |

## Request examples

*Write a note on an entity*

**cURL**

```bash
curl https://app.filmo.io/api/v1/notes \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "relatedDocumentType": "item",
  "relatedDocumentId": "itm_9f3a2b",
  "subRelatedDocumentType": "serializedItem",
  "subRelatedDocumentId": "ser_00187",
  "subRelatedDocumentCode": "FX6-01",
  "content": "Revisada la montura tras el rodaje; sin holgura."
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/notes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    relatedDocumentType: 'item',
    relatedDocumentId: 'itm_9f3a2b',
    subRelatedDocumentType: 'serializedItem',
    subRelatedDocumentId: 'ser_00187',
    subRelatedDocumentCode: 'FX6-01',
    content: 'Revisada la montura tras el rodaje; sin holgura.'
  })
})
```

**Python**

```python
import uuid
import requests

requests.post("https://app.filmo.io/api/v1/notes",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "relatedDocumentType": "item",
      "relatedDocumentId": "itm_9f3a2b",
      "subRelatedDocumentType": "serializedItem",
      "subRelatedDocumentId": "ser_00187",
      "subRelatedDocumentCode": "FX6-01",
      "content": "Revisada la montura tras el rodaje; sin holgura."
    }
)
```

## Response

Response schema: `NoteDto`

| Status | Description |
| --- | --- |
| 201 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**201**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Note attached to an entity of the account. |
| `data.id` | string | Unique identifier of the note. |
| `data.content` | string | Note text. |
| `data.relatedDocumentType` | string | Type of the entity the note is attached to; null if it is not attached. |
| `data.relatedDocumentId` | string | Identifier of that entity; null if the note is not attached. |
| `data.subRelatedDocumentType` | string | Type of the sub-entity; null if not applicable. |
| `data.subRelatedDocumentId` | string | Identifier of the sub-entity; null if not applicable. |
| `data.subRelatedDocumentCode` | string | Human-readable code of the sub-entity; null if not applicable. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 201*

```json
{
  "data": {
    "id": "note_9f3a2b",
    "content": "Example content",
    "relatedDocumentType": "Example related document type",
    "relatedDocumentId": "related_document_9f3a2b",
    "subRelatedDocumentType": "Example sub related document type",
    "subRelatedDocumentId": "sub_related_document_9f3a2b",
    "subRelatedDocumentCode": "Example sub related document code",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/notes/write-a-note-on-an-entity  
Last updated: 2026-10-25