*API REST › Referencia de endpoints › Plataforma › Notas*

# Escribe una nota en una entidad

> Deja un registro en una entidad de la cuenta: por qué se rechazó un pedido, cómo va una reparación.

Con `subRelatedDocumentType` y `subRelatedDocumentId` la nota va en una unidad física concreta y no en el artículo entero. `mentionedUserIds` notifica a esos usuarios de Filmo. Las notas de una entidad se leen con [`GET /api/v1/notes`](https://docs.filmo.io/es/rest-api/endpoint-reference/notes/list-the-notes-of-an-entity).

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

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

## Autorizaciones

Clave de API como Bearer, con el permiso de abajo. `notes:write`

## Cabeceras

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Identificador único de la petición, elegido por el cliente (sirve un UUID). Entre 1 y 255 caracteres: una cabecera vacía se rechaza con 400 `validation_error`, porque el cliente se creería protegido. Repetir la misma clave con el MISMO cuerpo en 24 h devuelve la respuesta guardada sin volver a ejecutar, con la cabecera `Idempotent-Replay: true`. Con un cuerpo DISTINTO devuelve 422. Es la forma segura de reintentar tras un tiempo de espera de red. |

## Cuerpo

Esquema del cuerpo: `NoteCreateBody`

| Nombre | Tipo | Obligatorio | Descripción |
| --- | --- | --- | --- |
| `relatedDocumentType` | string | Sí | Tipo de la entidad a la que está adjunta la nota. `item`, `contact`, `order`, `space`, `kit`, `vehicle`, `staff`, `service`, `collection`, `project`, `repairTicket`, `purchaseOrder`, `supplierInvoice` |
| `relatedDocumentId` | string | Sí | Identificador de esa entidad. |
| `content` | string | Sí | Texto de la nota. |
| `subRelatedDocumentType` | string | No | Cuando la nota se refiere a una unidad física concreta del artículo. `serializedItem` |
| `subRelatedDocumentId` | string | No | Identificador de esa unidad física. Requiere `subRelatedDocumentType`. |
| `subRelatedDocumentCode` | string | No | Código de la unidad, para poder leerlo en la nota sin resolver el id. |
| `mentionedUserIds` | string[] | No | Usuarios de Filmo a notificar. Cada uno recibe una notificación. |

## Ejemplos de petición

*Escribe una nota en una entidad*

**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."
    }
)
```

## Respuesta

Esquema de la respuesta: `NoteDto`

| Estado | Descripción |
| --- | --- |
| 201 | Respuesta correcta. |
| 400 | Petición no válida (validation_error): consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |
| 401 | Fallo de autenticación (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | No permitido (insufficient_scope: la clave de API no tiene el scope requerido, indicado en `requiredScope`; forbidden: el propietario de la clave carece del permiso que exige la operación). `insufficient_scope` se responde antes de que la petición cuente contra el límite de peticiones, así que no lleva cabeceras `RateLimit-*`; `forbidden` sí. |
| 404 | Recurso no encontrado (not_found): no existe o está fuera del alcance de la clave de API. |
| 409 | Conflicto (conflict): el estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, o otra escritura condicional (`If-Match`) retuvo el recurso durante más de cinco segundos. `errors[0].code` indica cuál: `in_progress` y `lock_timeout` se resuelven reintentando; `invalid_state` no, porque el estado del recurso prohíbe la operación. |
| 422 | Idempotency-Key reutilizada (idempotency_key_reused): la misma clave se usó antes con un cuerpo distinto. Cambia la clave. |
| 429 | Límite de peticiones superado (rate_limited): reintenta tras `Retry-After` segundos; `RateLimit-*` indica qué cuota se ha agotado. |
| 500 | Error interno (internal_error). |

**201**

| Nombre | Tipo | Descripción |
| --- | --- | --- |
| `data` | object | Nota asociada a una entidad de la cuenta. |
| `data.id` | string | Identificador único de la nota. |
| `data.content` | string | Texto de la nota. |
| `data.relatedDocumentType` | string | Tipo de la entidad a la que está adjunta la nota; null si no está adjunta. |
| `data.relatedDocumentId` | string | Identificador de esa entidad; null si la nota no está asociada. |
| `data.subRelatedDocumentType` | string | Tipo de la subentidad; null si no aplica. |
| `data.subRelatedDocumentId` | string | Identificador de la subentidad; null si no aplica. |
| `data.subRelatedDocumentCode` | string | Código legible de la subentidad; null si no aplica. |
| `data.createdAt` | string<date-time> | Fecha de creación en ISO 8601 UTC. |
| `data.updatedAt` | string<date-time> | Fecha de la última modificación en ISO 8601 UTC. |
| `meta` | object | Información adicional sobre la respuesta. |
| `meta.warnings` | object[] | Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta. |
| `meta.warnings.code` | string | Código de aviso estable. `deprecated` |
| `meta.warnings.message` | string | Para personas: qué está obsoleto, hasta cuándo y qué usar. |
| `meta.warnings.sunset` | string | Día (YYYY-MM-DD) en que la operación deja de estar disponible. |
| `meta.warnings.replacement` | string | `operationId` de la operación que hay que usar en su lugar, o null si no hay ninguna. |
| `meta.warnings.link` | string | Dónde está documentada la deprecación (el changelog). |

*Respuesta de ejemplo · 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"
  }
}
```

## Errores

| Estado | Códigos | Significado |
| --- | --- | --- |
| 400 | `validation_error` | Consulta o cuerpo mal formados. `errors[]` enumera cada campo erróneo con su código estable. |
| 404 | `not_found` | No existe o queda fuera del alcance de la clave de API. |
| 409 | `conflict` | El estado actual del recurso impide la operación, ya hay en curso una petición con esa Idempotency-Key, u otra escritura condicional (`If-Match`) retuvo el recurso durante más de cinco segundos. `errors[0].code` indica cuál: `in_progress` y `lock_timeout` se resuelven reintentando; `invalid_state` no, porque el estado del recurso prohíbe la operación. |
| 422 | `idempotency_key_reused` | La misma clave se usó antes con un cuerpo distinto. Cambia la clave. |

## Obsolescencia

Esta operación no está obsoleta. Las obsolescencias se anuncian con la cabecera Deprecation y una fecha de retirada.

---

URL canónica: https://docs.filmo.io/es/rest-api/endpoint-reference/notes/write-a-note-on-an-entity  
Última actualización: 2026-10-25