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

# Partially update a project

`PATCH /projects/{id}/`

## Request

- Base URL: `https://api.parsewise.ai/api/v1`
- URL: `https://api.parsewise.ai/api/v1/projects/{id}/`
- Auth: API key in header `X-API-Key`

Update one or more fields on an existing project (supply only the fields you want to change). Returns the updated project. Returns `404` if the project does not exist.

## Path parameters

- `id` string, uuid, required

## Request body

- PatchedV1ProjectRequest: A project: the top-level container that groups documents, agents, and extraction results. Returned by `GET /projects/` and `GET /projects/{project_id}/`; also accepted as the request body for `PATCH /projects/{project_id}/`, where only the fields you supply are updated. Server-managed fields such as `id`, `created_at`, `last_visited_at`, `document_count`, and `agent_count` are read-only.
  - `name` string: Human-readable name shown in the UI and in lists.
  - `description` string: Short description of what the project covers.
  - `reference_date` string, date, nullable: Reference date used by agents that need a "today" anchor (e.g. relative date extractions). Defaults to the date the project was created.
  - `auto_archive_after_days` integer, nullable: Opt-in auto-archival for document-oriented projects: documents uploaded more than this many days ago are automatically moved into an archived project by a daily sweep. Null disables auto-archival.
  - `is_pinned` boolean: Whether the project is pinned to the top of the project list.
  - `folder_id` string, uuid, nullable: Folder that contains this project. Null means the project sits at the root of the organisation folder tree.

## Response `200`

- V1Project: A project: the top-level container that groups documents, agents, and extraction results. Returned by `GET /projects/` and `GET /projects/{project_id}/`; also accepted as the request body for `PATCH /projects/{project_id}/`, where only the fields you supply are updated. Server-managed fields such as `id`, `created_at`, `last_visited_at`, `document_count`, and `agent_count` are read-only.
  - `id` string, uuid, required: Stable identifier for the project (UUID).
  - `name` string, required: Human-readable name shown in the UI and in lists.
  - `description` string: Short description of what the project covers.
  - `last_visited_at` string, date-time, nullable, required: Timestamp of the most recent visit to this project.
  - `reference_date` string, date, nullable: Reference date used by agents that need a "today" anchor (e.g. relative date extractions). Defaults to the date the project was created.
  - `auto_archive_after_days` integer, nullable: Opt-in auto-archival for document-oriented projects: documents uploaded more than this many days ago are automatically moved into an archived project by a daily sweep. Null disables auto-archival.
  - `document_count` integer, required: Number of documents currently in the project.
  - `agent_count` integer, required: Number of non-draft agents configured on the project.
  - `is_pinned` boolean: Whether the project is pinned to the top of the project list.
  - `folder_id` string, uuid, nullable: Folder that contains this project. Null means the project sits at the root of the organisation folder tree.
  - `project_modules` unknown, required
  - `target_output_schema` unknown, required
  - `output_mapping_status` string, required

---

[API](https://skmtc.dev/parsewise/apis/parsewise-api.md) - [All operations](https://skmtc.dev/parsewise/apis/parsewise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/parsewise/apis/parsewise-api/revisions/5db46512debf?raw)