---
title: "Update a project within an organization"
method: PATCH
path: "/projects/{project_id}"
---

# Update a project within an organization

`PATCH /projects/{project_id}`

## Request

- Base URL: `https://api.ionworks.com`
- URL: `https://api.ionworks.com/projects/{project_id}`
- Auth: none declared

## Path parameters

- `project_id` string, uuid, required

## Request body

- ProjectUpdate
  - `name` string, nullable: The name of the project.
  - `description` string, nullable: An optional description for the project.

## Response `200`

Successful Response

- Project
  - `name` string, required: The name of the project.
  - `description` string, nullable: An optional description for the project.
  - `id` string, required: The unique identifier for the project.
  - `organization_id` string, required: The ID of the organization this project belongs to.
  - `created_at` string, date-time, required: Timestamp of when the project was created.
  - `updated_at` string, date-time, required: Timestamp of when the project was last updated.
  - `created_by` string, nullable: User ID of the creator.
  - `my_role` string, nullable: The caller's role in the project, or null if they are not a member.
  - `my_permissions` string[]: The permission actions the caller's project role grants, e.g. ``pipeline:read``. Empty if they are not a member.

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-30** `fb09ebb2c64e`: 1 warning, 2 info
  - removed the optional property `user_project_roles` from the response with the `200` status
  - added the optional property `my_permissions` to the response with the `200` status
  - added the optional property `my_role` to the response with the `200` status
- **2026-09-30** `ea3d377fec1a`: 1 breaking
  - for the `path` request parameter `project_id`, the format changed from no format to `uuid`

[Operation history](https://skmtc.dev/ionworks/apis/ionworks-api/changes/projects/:project_id/patch.md)

---

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