---
title: "Update a project"
method: PATCH
path: "/projects/{id}"
tags: ["Objects"]
---

# Update a project

`PATCH /projects/{id}`

Updates an existing project. Only provided fields will be updated. Moving stageId to a closed (WON) stage completes the project; you can also set status directly. Custom field values use `cf_*` keys — see the [Custom fields](/api-v2/custom-fields) guide.

## Path parameters

- `id` string, required

## Request body

- ProjectUpdateInput
  - `title` string — Project title
  - `pipelineId` string — Project pipeline ID (ppl_ prefix)
  - `stageId` string, nullable — Project pipeline stage ID (pps_ prefix). If omitted, the first OPEN stage in the pipeline is used.
  - `clientId` string, nullable — Contact or company ID (clt_ prefix)
  - `projectLeadId` string, nullable — Project lead user ID (usr_ prefix). Defaults to the API key user when omitted.
  - `salesPersonId` string, nullable — Sales person user ID (usr_ prefix)
  - `status` 'ACTIVE' | 'COMPLETED' | 'CANCELLED' — Project status
  - `type` 'flat_rate' | 'retainer' — Project type
  - `startDate` string, date-time — Project start date
  - `endDate` string, date-time — Project end date
  - `budgetedHours` number — Budgeted hours
  - `description` string — Project description
  - `isInclusiveTax` boolean — Whether project line item prices include tax
  - `assignees` string[] — Assignee user IDs (usr_ prefix)
  - `tags` string[] — Tag IDs (tag_ prefix)

## Response `200`

OK

- Project
  - `id` string, nullable, required — Project ID (prj_ prefix)
  - `number` string, required — Auto-generated project number
  - `title` string, required — Project title
  - `status` 'ACTIVE' | 'COMPLETED' | 'CANCELLED', nullable — Project status
  - `type` 'flat_rate' | 'retainer', nullable — Project type
  - `startDate` string, date-time, nullable — Project start date
  - `endDate` string, date-time, nullable — Project end date
  - `pipelineId` string, nullable — Project pipeline ID (ppl_ prefix)
  - `pipelineName` string, nullable — Pipeline name
  - `stageId` string, nullable — Project pipeline stage ID (pps_ prefix)
  - `stageName` string, nullable — Stage name
  - `projectLeadId` string, nullable — Project lead user ID (usr_ prefix)
  - `projectLeadName` string, nullable — Project lead name
  - `clientId` string, nullable — Client ID (clt_ prefix)
  - `clientName` string, nullable — Client name
  - `description` string, nullable — Project description
  - `budgetedHours` number, nullable — Budgeted hours
  - `createdAt` string, date-time, nullable — When the project was created
  - `updatedAt` string, date-time, nullable — When the project was last updated

## Other responses

- `400` — Validation error or bad request
- `401` — Missing or invalid API key
- `403` — Insufficient permission
- `404` — Resource not found
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/heffl/apis/heffl-api-v2-beta.md) · [All operations](https://skmtc.net/heffl/apis/heffl-api-v2-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heffl/heffl-api-v2-beta/versions/27006cfef4d8/schema)