Skip to main content
PATCH /api/v1/projects/{project_id} Requires projects.write permission. Only provided fields are updated.

Path parameters

project_id
string
required
UUID of the project.

Request body

name
string
New display name for the project.
description
string | null
New description. Pass null to clear the existing value.

Response

project
object
required
The updated project.

Errors

StatusWhen
403Caller lacks projects.write permission
404Project not found

Example

curl -X PATCH http://localhost:8080/api/v1/projects/p1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "Renamed Project", "description": "Updated description"}'
{
  "project": {
    "id": "p1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "organization_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "slug": "my-project",
    "name": "Renamed Project",
    "description": "Updated description",
    "created_at": "2026-01-15T09:00:00Z",
    "updated_at": "2026-03-21T11:00:00Z"
  }
}

Build docs developers (and LLMs) love