---
title: "Update Work Project"
method: PATCH
path: "/work/projects/{project_id}"
tags: ["Work"]
---

# Update Work Project

`PATCH /work/projects/{project_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/work/projects/{project_id}`
- Auth: HTTP bearer

Rename one project, re-describe it, or move its status.

**Field PRESENCE is the contract**: an omitted field keeps its stored
value and ``description: null`` clears it. ``403`` unless the caller
created the project or holds Owner/Admin — the SAME rule deletion uses, and
the role half only answers correctly because of ``with_org_role``.

## Path parameters

- `project_id` string, required: Project id

## Headers

- `Idempotency-Key` string, nullable: Retry-safety key. Replaying one returns the ORIGINAL result with `duplicate: true` instead of writing twice. Omit it and the server mints a single-use key, which means a retried request writes again — send your own for anything you may retry.
- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- WorkProjectUpdateRequest: One project being changed. Field PRESENCE is the contract. `channel` is absent on purpose: a project's channel is where its messages and receipts already point, so moving one would strand them. Renaming, re-describing and moving its status are what this accepts.
  - `name` string, nullable
  - `description` string, nullable
  - `status` 'active' | 'paused' | 'completed' | 'archived', nullable

## Response `200`

Successful Response

- ApiResponseWorkProjectWriteResult
  - `data` WorkProjectWriteResult, required: The result of one project write, with its idempotent-replay marker.
    - `project` WorkProject: One project: a named unit of work attached to a channel.
      - `id` string, nullable: Project id, minted server-side
      - `name` string, nullable: Project name
      - `description` string, nullable: Project description; null when cleared
      - `status` string, nullable: `active`, `paused`, `completed` or `archived`
      - `channel` string, nullable: Channel the project belongs to
      - `createdBy` string, nullable: Ownership identity of whoever created it
    - `duplicate` boolean, nullable: True when an Idempotency-Key replay returned the original result rather than writing again
    - `compatibilityEventId` string, nullable: Id of the room event the write appended
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/89fc11143b70?raw)