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

# Update a project

`PATCH /projects/{id}`

## Request

- Base URL: `https://app.pencil.ink/api/v1`
- URL: `https://app.pencil.ink/api/v1/projects/{id}`
- Auth: HTTP bearer

Requires a `write` key.

## Request body

- ProjectUpdate
  - `name` string
  - `description` string
  - `status` 'active' | 'paused' | 'on_hold' | 'completed' | 'archived'
  - `dueDate` integer: Epoch ms.
  - `projectType` 'kanban' | 'content'

## Response `200`

A single project.

- object
  - `data` Project
    - `id` string
    - `name` string
    - `description` string, nullable
    - `status` 'active' | 'paused' | 'on_hold' | 'completed' | 'archived'
    - `projectType` 'kanban' | 'content'
    - `dueDate` integer, nullable: Epoch ms.
    - `leadAgentId` string, nullable
    - `productId` string, nullable
    - `taskCount` integer
    - `createdAt` integer: Epoch ms.
    - `updatedAt` integer, nullable: Epoch ms.

## Other responses

- `400`: Malformed request or invalid field (`validation_error`).
- `401`: Missing or invalid API key (`unauthorized`).
- `403`: The key is read-only and may not write (`forbidden`).
- `404`: Resource not found in this org (`not_found`).

---

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