Projects

Update a project custom field

Partially update a custom field definition. Removing an option that tasks still use, or changing the type in a way their values cannot follow, returns 422 invalid_custom_field_definition.

patch/companies/{company}/projects/{project}/custom-fields/{field}

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/projects/{project}/custom-fields/{field}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

projectstring uuid required

Public identifier (UUID v7) of the project.

fieldstring uuid required

Public identifier (UUID v7) of the project custom field.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

namestring

New name.

typestring

Type: immutable; a value different from the current one returns 422 invalid_custom_field_definition.

requiredboolean

Whether the field is required.

optionsstring[] nullable

Complete resulting list of options (up to 100).

Response

Example response

{
  "data": {
    "id": "0193a4f2-7e42-7c33-8d74-6f8a0b2c4e01",
    "object": "project_custom_field",
    "project_id": "0193a4f2-7c20-7a11-8b52-4d6e8f0a2c01",
    "name": "Estimación (h)",
    "type": "number",
    "options": []
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.