Projects

Update a project

Changes the record of a project: name, dates, customer, type, external reference, location and color (send only the fields to change).

PATCH

/api/v1/projects/{projectId}

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"
  }
}'

Node.jsfetch('https://app.filmo.io/api/v1/projects/proj_8f2a1c', { method: 'PATCH', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ 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' } }) })Pythonimport uuid import requests requests.patch( "https://app.filmo.io/api/v1/projects/proj_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "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"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "projects:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

It does NOT change the status, the archiving or the linked orders: links have their own sub-resource. An archived project is read-only: the request is rejected with 409 conflict and nothing is written; unarchive it first with PUT /api/v1/projects/{projectId}/archive and archived: false. The customer and the project type are checked against the account of the API key before writing anything. Returns the full project, the same projection as its GET.

Authorizations

Bearer API key with the scope below. projects:write

Headers

Idempotency-Keystring

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.

Limits: min length 1, max length 255

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

If-Matchstring

Optimistic locking: the ETag you read from the resource (or *). If the resource changed since, the write is rejected with 412 precondition_failed before doing anything; read it again and retry. Without the header the write always proceeds.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

projectIdstringRequired

Project identifier.

Limits: min length 1

Body

application/json

Body schema: ProjectUpdateBody

namestring

Project name. At least three characters, as the domain requires.

Limits: min length 3, max length 200

startDatestring<date-time>

Project start (ISO 8601 with offset).

endDatestring<date-time>

Project end (ISO 8601 with offset). It cannot be earlier than startDate; the same instant is a one-day project.

contactIdstring

Project customer. It must belong to the account of the API key.

Limits: min length 1, max length 100

projectTypeIdstring | null

Project type; resolve it against /api/v1/project-types. null clears it.

Limits: min length 1, max length 100

externalReferencestring | null

Free-form reference to match the project with an external system; null clears it.

Limits: max length 200

locationobject

Physical location of the project (a stage, a client site). Only the fields sent are recorded.

Show child attributes

location.namestring

Name of the place, for example "Main stage".

Limits: max length 200

location.addressstring

Street address.

Limits: max length 500

location.citystring

City.

Limits: max length 200

location.postalCodestring

Postal code.

Limits: max length 20

location.provincestring

Province or region.

Limits: max length 200

location.countrystring

Country.

Limits: max length 200

location.latnumber

Latitude in decimal degrees.

Limits: min -90, max 90

location.lngnumber

Longitude in decimal degrees.

Limits: min -180, max 180

colorstring | null

Color of the project card (for example "#3b82f6"); null clears it.

Limits: max length 40

Response

application/json

Successful response.

Response schema: ProjectDetailDto

Envelope: ProjectDetailResponse. meta.warnings is present only when the operation is deprecated.

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

dataobject

The project in full, as returned by the API.

Show child attributes

data.idstring

Unique project identifier.

data.projectNumberstring | null

Human-readable project number; null if not numbered.

data.namestring

Project name.

data.colorstring | null

Color associated with the project (for the UI); null if none.

data.externalReferencestring | null

External reference of the project (for example, from the customer system); null if not recorded.

data.projectTypeIdstring | null

Project type identifier; null if the project has no type.

data.projectTypeobject | null

Compact reference to the project type; null if none.

Show child attributes

data.projectType.idstring

Unique project type identifier.

data.projectType.namestring

Project type name.

data.projectType.colorstring | null

Color associated with the project type (for the UI); null if none.

data.contactobject | null

Compact reference to the project contact; null if none.

Show child attributes

data.contact.idstring

Unique contact identifier.

data.contact.namestring

Contact name.

data.locationobject

Project location; its inner fields are null when not recorded.

Show child attributes

data.location.namestring | null

Name of the place/location; null if not recorded.

data.location.addressstring | null

Address of the location; null if not recorded.

data.location.citystring | null

City of the location; null if not recorded.

data.location.postalCodestring | null

Postal code of the location; null if not recorded.

data.location.provincestring | null

Province or region of the location; null if not recorded.

data.location.countrystring | null

Country of the location; null if not recorded.

data.location.latnumber | null

Latitude of the location; null if not recorded.

data.location.lngnumber | null

Longitude of the location; null if not recorded.

data.startDatestring<date-time>

Project start date in ISO 8601 with offset.

data.endDatestring<date-time>

Project end date in ISO 8601 with offset.

data.statusstring

Project status: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled or archived. archived is a LEGACY status that appears in old data; the current archived state is expressed by the archived boolean of this same DTO.

Available options: draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived

data.archivedboolean

Whether the project is archived.

data.orderIdsstring[]

Identifiers of the project orders. Order details are obtained from GET /api/v1/orders?projectId=.

data.totalOrdersinteger

Total number of orders in the project (equals orderIds.length).

data.tagsobject[]

Tags attached to the project, with their identifier and name.

Show child attributes

data.tags.idstring

Unique identifier of the tag.

data.tags.namestring

Tag name.

data.customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

data.sourcestring | null

Source the project was created from; null if not recorded.

data.createdAtstring<date-time>

Creation date in ISO 8601 with offset.

data.updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

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.
412	`precondition_failed`	The `If-Match` entity tag does not match the current representation. Read the resource again and retry.
422	`idempotency_key_reused`	The same key was used before with a different body. Change the key.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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

Rentals
Project
The project, as returned by the API.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Body

Response

Errors

Deprecation

Related

Related pages

Project