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

# Update a Project.

`PATCH /projects/{id}`

## Request

- Base URL: `https://restivity.ai/api/v1`
- URL: `https://restivity.ai/api/v1/projects/{id}`
- Auth: OAuth 2 (authorization code, authorization URL `https://restivity.ai/oauth/authorize`, token URL `https://restivity.ai/api/oauth/token`, scopes: `projects:write`)

Partial update — omitted fields are left untouched. Admitted for the project's creator (while a member of its team and workspace) or an admin of its team, as on the web. A member who can see the project and may not edit it is refused with 403 `forbidden`; a project the caller cannot see is 404.

## Path parameters

- `id` string, uuid, required

## Request body

- UpdateProjectInput
  - `name` string
  - `description` string: A project `description` is plain text, at most 10,000 characters: marked text (`**bold**`, `- ` and `1. ` lists, `` `code` ``, links) or HTML is accepted and stored as its words — markers and tags removed, list items kept as `- ` / `1. ` lines — so a project card shows no asterisks, backticks or tags
  - `color` string
  - `is_archived` boolean
  - `team_id` string, uuid, nullable
  - `prefix` string: New project key (2–5 uppercase letters/digits, leading letter) — reissues every task code in the project (old codes keep resolving). Omit to keep the current key; a key cannot be removed (null is refused).

## Response `200`

The updated Project.

- Project
  - `id` string, uuid, required
  - `user_id` string, uuid, required
  - `name` string, required
  - `description` string, required
  - `color` string, required
  - `is_archived` boolean, required
  - `team_id` string, uuid, nullable, required
  - `prefix` string, nullable, required
  - `task_counter` integer, required
  - `created_at` string, required
  - `updated_at` string, required
  - `deleted_at` string, nullable, required
  - `url` string
  - `scope` string
  - `firestore_id` string, nullable
  - `team_name` string, nullable
  - `team_slug` string, nullable
  - `task_count` integer
  - `completed_task_count` integer
  - `overdue_task_count` integer
  - `next_due_date` string, nullable
  - `is_agent_inbox` boolean
  - `workspace_id` string, uuid, nullable
  - `workspace_short_id` string, nullable
  - `workspace_slug` string, nullable
  - `team_short_id` string, nullable

## Other responses

- `400`: Invalid request shape.
- `401`: Missing or invalid access token.
- `403`: Token lacks the required scope.
- `404`: No such Project.
- `409`: `name_taken` — The scope already has a project of this name: its team for a team project, its workspace for a project in no team. Names are compared without case and without surrounding spaces; nothing was written. Rename, or use the existing project.
- `422`: Request body failed schema validation.
- `429`: Rate-limit exceeded for this tier.

---

[API](https://skmtc.dev/restivity/apis/restivity-rest-api.md) · [All operations](https://skmtc.dev/restivity/apis/restivity-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/restivity/apis/restivity-rest-api/revisions/5764e41ebb3a?raw)