---
title: "Update a project"
method: PATCH
path: "/companies/{company}/projects/{project}"
tags: ["Projects"]
---

# Update a project

`PATCH /companies/{company}/projects/{project}`

## Request

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

Partially update a project: only the fields you send change.
- Editable: `name`, `key` (old key stays as alias), `icon`, `description`, billing defaults.
- A `key` already in use returns 409 `project_key_in_use`.

## Path parameters

- `company` string, uuid, required
- `project` string, uuid, required

## Headers

- `Idempotency-Key` string
- `Factuarea-Version` string, date

## Request body

- UpdateProjectV1Request
  - `name` string: New name (1-120 characters); `null` is not accepted.
  - `key` string: New key; `null` is not accepted. The previous key remains as an alias of the keys of its tasks.
  - `icon` 'folder' | 'briefcase' | 'rocket' | 'code' | 'bug' | 'wrench' | 'hammer' | 'truck' | 'package' | 'shopping-cart' | 'calculator' | 'receipt' | 'file-text' | 'landmark' | 'users' | 'user' | 'building' | 'home' | 'calendar' | 'clock' | 'flag' | 'star' | 'heart' | 'lightbulb' | 'target' | 'trophy' | 'book' | 'graduation-cap' | 'megaphone' | 'palette' | 'camera' | 'music' | 'globe' | 'leaf' | 'coffee' | 'car' | 'plane' | 'shield' | 'zap' | 'layers': Icon from the catalog; `null` is not accepted.
  - `description` string, nullable: Description; `null` clears it.
  - `billing_contact_id` string, uuid, nullable: `id` of the client contact the hours are invoiced to; `null` removes it.
  - `billing_product_id` string, uuid, nullable: `id` of the product the hours are invoiced with; `null` removes it.
  - `billing_hourly_rate` number, nullable: Hourly rate (decimal with up to 2 decimal places); `null` removes it.

## Response `200`

- object
  - `data` Project, required: A task project of your company: its board columns hold the tasks, and its key (`DEV`) prefixes their keys (`DEV-12`).
    - `id` string, uuid, required: UUID v7 of the project.
    - `object` 'project', required: Stripe-like discriminator. Always `project` for this resource.
    - `key` string, required: Project key, unique in your company. Prefixes the key of every task (`DEV-12`).
    - `name` string, required: Project name.
    - `icon` string, required: Icon of the project, from the task icon catalog.
    - `description` string, nullable, required: Free description of the project, or `null`.
    - `position` integer, required: Position of the project in the list shown in the app.
    - `is_archived` boolean, required: `true` when the project is archived (read-only, no new tasks).
    - `archived_at` string, date-time, nullable, required: When the project was archived, or `null`.
    - `billing_contact_id` string, uuid, nullable, required: UUID of the contact invoiced by default for the logged time, or `null`.
    - `billing_hourly_rate` string, nullable, required: Default hourly rate (decimal string, before taxes) used to invoice the logged time, or `null`.
    - `billing_product_id` string, uuid, nullable, required: UUID of the product used for the invoice lines of logged time, or `null`.
    - `stats` object, required: Task statistics of the project.
      - `total_tasks` integer, required: Tasks of the project, archived ones included.
      - `completed_tasks` integer, required: Completed tasks.
      - `completion_percentage` integer, required: Completed tasks over total, as a whole percentage.
      - `next_due_on` string, date, nullable, required: Earliest due date among the open tasks, or `null`.
    - `created_at` string, date-time, required: Creation timestamp.
    - `updated_at` string, date-time, required: Last update timestamp.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `409`: The request conflicts with data that already exists or with a request running at the same time. `column_has_tasks`: the column still holds tasks. Move them to another column (`move_to_column_id`) before deleting it. `column_slug_in_use`: another column of the project already has that name (or one that produces the same identifier). Choose another name. `project_key_in_use`: another project of the company already uses that `key`. Choose another one.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)