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).

Tool

filmo_projects_update

Writeprojects:write

projects:write
120/min
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_projects_update",
    "arguments": {
      "projectId": "proj_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "projectNumber": "<projectNumber>",
      "name": "Example",
      "color": "<color>",
      "externalReference": "<externalReference>",
      "projectTypeId": "proj_8f2a1c",
      "projectType": {
        "id": "id_8f2a1c",
        "name": "Example",
        "color": "<color>"
      },
      "contact": {
        "id": "id_8f2a1c",
        "name": "Example"
      },
      "location": {
        "name": "Example",
        "address": "<address>",
        "city": "<city>",
        "postalCode": "<postalCode>",
        "province": "<province>",
        "country": "ES",
        "lat": 1,
        "lng": 1
      },
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "status": "draft",
      "archived": true,
      "orderIds": [
        "orde_8f2a1c"
      ],
      "totalOrders": 1,
      "tags": [
        {
          "id": "id_8f2a1c",
          "name": "Example"
        }
      ],
      "customFields": {
        "key": "<key>"
      },
      "source": "<source>",
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z"
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

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.

Arguments

projectIdstringRequired

Project identifier.

Limits: min length 1

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

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique project identifier.

projectNumberstring | null

Human-readable project number; null if not numbered.

namestring

Project name.

colorstring | null

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

externalReferencestring | null

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

projectTypeIdstring | null

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

projectTypeobject | null

Compact reference to the project type; null if none.

Show child attributes

projectType.idstring

Unique project type identifier.

projectType.namestring

Project type name.

projectType.colorstring | null

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

contactobject | null

Compact reference to the project contact; null if none.

Show child attributes

contact.idstring

Unique contact identifier.

contact.namestring

Contact name.

locationobject

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

Show child attributes

location.namestring | null

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

location.addressstring | null

Address of the location; null if not recorded.

location.citystring | null

City of the location; null if not recorded.

location.postalCodestring | null

Postal code of the location; null if not recorded.

location.provincestring | null

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

location.countrystring | null

Country of the location; null if not recorded.

location.latnumber | null

Latitude of the location; null if not recorded.

location.lngnumber | null

Longitude of the location; null if not recorded.

startDatestring<date-time>

Project start date in ISO 8601 with offset.

endDatestring<date-time>

Project end date in ISO 8601 with offset.

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

archivedboolean

Whether the project is archived.

orderIdsstring[]

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

totalOrdersinteger

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

tagsobject[]

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

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

customFieldsobject<string, any>

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

sourcestring | null

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

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/projects/{projectId}.

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).
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Update a project

Safe writes

Errors