Colecciones

Actualizar una colección

Renombra una colección, la mueve a otro padre o cambia su orden.

PATCH
/api/v1/collections/{collectionId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/collections/coll_8f2a1c \
  --request PATCH \
  --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 '{
  "name": "Cámaras de cine",
  "order": 2
}'
{
  "data": {
    "id": "collection_update_result_9f3a2b",
    "updated": true
  }
}

Generado a partir del esquema

entityType no está: cambiarlo no está admitido. Un parentCollectionId que no existe o pertenece a otra cuenta, que es la propia colección o una de sus subcolecciones, o que agrupa un tipo de recurso distinto responde 400 validation_error con errors[0].path en ese campo; las colecciones del sistema no se pueden modificar (409 conflict). En ambos casos no se escribe nada. Devuelve la confirmación, no el registro, porque este recurso no publica una lectura.

Autorizaciones

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

Cabeceras

Idempotency-Keystring

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.

Límites: longitud mín. 1, longitud máx. 255

Ejemplo:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

Parámetros de ruta

collectionIdstringObligatorio

Identificador de la colección.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: CollectionUpdateBody

namestring

Nombre de la colección.

Límites: longitud mín. 1

descriptionstring

Descripción de la colección.

parentCollectionIdstring | null

Nueva colección padre; null la mueve al nivel superior.

iconstring

Icono de la colección.

ordernumber

Orden de visualización entre sus hermanos.

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: CollectionUpdateResultDto

Sobre: CollectionUpdateResultResponse. meta.warnings solo aparece cuando la operación está obsoleta.

Cabeceras: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

Resultado de aplicar un patch a una colección.

Mostrar atributos hijos
data.idstring

Identificador de la colección actualizada.

data.updatedboolean

true cuando se aplicó el cambio.

metaobject

Información adicional sobre la respuesta.

Mostrar atributos hijos
meta.warningsobject[]

Avisos del ciclo de vida; solo aparecen cuando la operación está obsoleta.

Mostrar atributos hijos
meta.warnings.codestring

Código de aviso estable.

Opciones disponibles: deprecated

meta.warnings.messagestring

Para personas: qué está obsoleto, hasta cuándo y qué usar.

meta.warnings.sunsetstring

Día (YYYY-MM-DD) en que la operación deja de estar disponible.

meta.warnings.replacementstring | null

operationId de la operación que hay que usar en su lugar, o null si no hay ninguna.

Errores

EstadoCódigosSignificado
400validation_errorConsulta o cuerpo mal formados. errors[] enumera cada campo erróneo con su código estable.
404not_foundNo existe o queda fuera del alcance de la clave de API.
409conflictEl 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.
422idempotency_key_reusedLa misma clave se usó antes con un cuerpo distinto. Cambia la clave.

401, 403, 429, 500 los puede devolver cualquier operación. Errores

Obsolescencia

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