Projects

Update a project

Update a project's name, description, or custom instructions. Only the fields you supply are changed; omitted fields are left untouched. Pass null for description or custom_instructions to clear them.

Requires write access to the project. Org-scoped keys can update non-access-controlled projects.

patch/projects/{id}

Request

Path parameters

idstring uuid required

The project ID

Request body

namestring

New project name (non-empty after trim)

descriptionstring nullable

New project description, or null to clear it

custom_instructionsstring nullable

New custom instructions for chats in this project, or null to clear them

Example request

{
  "name": "Vendor: Acme MSA (renamed)"
}

Response

Updated project

idstring uuid required

Unique project identifier

namestring required

Project name

descriptionstring nullable required

Project description, or null if unset

custom_instructionsstring nullable required

Custom instructions injected into chats opened in this project

is_access_controlledboolean required

When true, only the creator and explicitly granted users can see the project. When false, any member of the organization can see it.

my_access_level'read' | 'write' | 'admin' | 'null' nullable required

Caller's access level on this project: admin (creator or explicitly granted admin), write, read, or null if the caller has no recorded grant. null is also returned for org-scoped keys, which carry no user identity.

created_atstring required

ISO 8601 creation timestamp

updated_atstring required

ISO 8601 last-update timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.