Proyectos

Actualizar un proyecto

Cambia la ficha de un proyecto: nombre, fechas, cliente, tipo, referencia externa, ubicación y color (envía solo los campos que cambian).

PATCH
/api/v1/projects/{projectId}

Ejemplos de petición

curl https://app.filmo.io/api/v1/projects/proj_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 '{
  "startDate": "2026-09-08T08:00:00+02:00",
  "endDate": "2026-09-19T20:00:00+02:00",
  "externalReference": "CRM-2026-114",
  "location": {
    "name": "Plató 2",
    "address": "Ciudad de la Imagen",
    "city": "Pozuelo de Alarcón",
    "province": "Madrid",
    "country": "ES"
  }
}'
{
  "data": {
    "id": "project_9f3a2b",
    "projectNumber": "2026-0001",
    "name": "Example project",
    "color": "Example color",
    "externalReference": "2026-0001",
    "projectTypeId": "project_type_9f3a2b",
    "projectType": {
      "id": "project_type_9f3a2b",
      "name": "Example project type",
      "color": "Example color"
    },
    "contact": {
      "id": "contact_9f3a2b",
      "name": "Example contact"
    },
    "location": {
      "name": "Example location",
      "address": "Example address",
      "city": "Madrid",
      "postalCode": "28001",
      "province": "Madrid",
      "country": "ES",
      "lat": 1,
      "lng": 1
    },
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "status": "draft",
    "archived": true,
    "orderIds": [
      "order_9f3a2b"
    ],
    "totalOrders": 1,
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "customFields": {
      "example": "example"
    },
    "source": "Example source",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

Generado a partir del esquema

NO cambia el estado, el archivado ni los pedidos vinculados: los vínculos tienen su propio subrecurso. Un proyecto archivado es de solo lectura: la petición se rechaza con 409 conflict y no se escribe nada; desarchívalo antes con PUT /api/v1/projects/{projectId}/archive y archived: false. El cliente y el tipo de proyecto se comprueban contra la cuenta de la clave de API antes de escribir nada. Devuelve el proyecto completo, con la misma proyección que su GET.

Autorizaciones

Clave de API como Bearer, con el permiso de abajo. projects: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"

If-Matchstring

Bloqueo optimista: el ETag que leíste del recurso (o *). Si el recurso ha cambiado desde entonces, la escritura se rechaza con 412 precondition_failed antes de hacer nada; léelo de nuevo y reintenta. Sin la cabecera, la escritura siempre se realiza.

Ejemplo:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Parámetros de ruta

projectIdstringObligatorio

Identificador del proyecto.

Límites: longitud mín. 1

Cuerpo

application/json

Esquema del cuerpo: ProjectUpdateBody

namestring

Nombre del proyecto. Al menos tres caracteres, como exige el dominio.

Límites: longitud mín. 3, longitud máx. 200

startDatestring<date-time>

Inicio del proyecto (ISO 8601 con desplazamiento).

endDatestring<date-time>

Fin del proyecto (ISO 8601 con desplazamiento). No puede ser anterior a startDate; el mismo instante es un proyecto de un día.

contactIdstring

Cliente del proyecto. Debe pertenecer a la cuenta de la clave de API.

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

projectTypeIdstring | null

Tipo de proyecto; resuélvelo contra /api/v1/project-types. null lo borra.

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

externalReferencestring | null

Referencia de formato libre para cruzar el proyecto con un sistema externo; null la borra.

Límites: longitud máx. 200

locationobject

Ubicación física del proyecto (un plató, la sede de un cliente). Solo se registran los campos enviados.

Mostrar atributos hijos
location.namestring

Nombre del lugar, por ejemplo "Main stage".

Límites: longitud máx. 200

location.addressstring

Dirección postal.

Límites: longitud máx. 500

location.citystring

Ciudad.

Límites: longitud máx. 200

location.postalCodestring

Código postal.

Límites: longitud máx. 20

location.provincestring

Provincia o región.

Límites: longitud máx. 200

location.countrystring

País.

Límites: longitud máx. 200

location.latnumber

Latitud en grados decimales.

Límites: mín. -90, máx. 90

location.lngnumber

Longitud en grados decimales.

Límites: mín. -180, máx. 180

colorstring | null

Color de la tarjeta del proyecto (por ejemplo "#3b82f6"); null lo borra.

Límites: longitud máx. 40

Respuesta

application/json

Respuesta correcta.

Esquema de la respuesta: ProjectDetailDto

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

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

dataobject

El proyecto completo, tal como lo devuelve la API.

Mostrar atributos hijos
data.idstring

Identificador único del proyecto.

data.projectNumberstring | null

Número de proyecto legible; null si no está numerado.

data.namestring

Nombre del proyecto.

data.colorstring | null

Color asociado al proyecto (para la interfaz); null si no tiene.

data.externalReferencestring | null

Referencia externa del proyecto (por ejemplo, del sistema del cliente); null si no consta.

data.projectTypeIdstring | null

Identificador del tipo de proyecto; null si el proyecto no tiene tipo.

data.projectTypeobject | null

Referencia compacta al tipo de proyecto; null si no hay.

Mostrar atributos hijos
data.projectType.idstring

Identificador único del tipo de proyecto.

data.projectType.namestring

Nombre del tipo de proyecto.

data.projectType.colorstring | null

Color asociado al tipo de proyecto (para la interfaz); null si no tiene.

data.contactobject | null

Referencia compacta al contacto del proyecto; null si no hay.

Mostrar atributos hijos
data.contact.idstring

Identificador único del contacto.

data.contact.namestring

Nombre del contacto.

data.locationobject

Ubicación del proyecto; sus campos internos son null cuando no se han registrado.

Mostrar atributos hijos
data.location.namestring | null

Nombre del lugar o ubicación; null si no está registrado.

data.location.addressstring | null

Dirección de la ubicación; null si no consta.

data.location.citystring | null

Ciudad de la ubicación; null si no consta.

data.location.postalCodestring | null

Código postal de la ubicación; null si no se ha registrado.

data.location.provincestring | null

Provincia o región de la ubicación; null si no se ha registrado.

data.location.countrystring | null

País de la ubicación; null si no consta.

data.location.latnumber | null

Latitud de la ubicación; null si no está registrada.

data.location.lngnumber | null

Longitud de la ubicación; null si no está registrada.

data.startDatestring<date-time>

Fecha de inicio del proyecto en ISO 8601 con desplazamiento.

data.endDatestring<date-time>

Fecha de fin del proyecto en ISO 8601 con desplazamiento.

data.statusstring

Estado del proyecto: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled o archived. archived es un estado HEREDADO que aparece en datos antiguos; el estado archivado actual se expresa mediante el booleano archived de este mismo DTO.

Opciones disponibles: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

data.archivedboolean

Si el proyecto está archivado.

data.orderIdsstring[]

Identificadores de los pedidos del proyecto. El detalle de los pedidos se obtiene en GET /api/v1/orders?projectId=.

data.totalOrdersinteger

Número total de pedidos del proyecto (igual a orderIds.length).

data.tagsobject[]

Etiquetas adjuntas al proyecto, con su identificador y nombre.

Mostrar atributos hijos
data.tags.idstring

Identificador único de la etiqueta.

data.tags.namestring

Nombre de la etiqueta.

data.customFieldsobject<string, any>

Valores de los campos personalizados por identificador de campo personalizado; las definiciones están en /api/v1/custom-fields.

data.sourcestring | null

Origen desde el que se creó el proyecto; null si no consta.

data.createdAtstring<date-time>

Fecha de creación en ISO 8601 con desplazamiento.

data.updatedAtstring<date-time>

Fecha de la última actualización en ISO 8601 con desplazamiento.

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.
412precondition_failedLa etiqueta de entidad If-Match no coincide con la representación actual. Vuelve a leer el recurso y reintenta.
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

  • Alquileres

    Proyecto

    El proyecto, tal como lo devuelve la API.