v2

latestOpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB
Projects

Update a project

Update a project by its ID (rename).

Payload Requirements

  • name must be provided and must be unique within the space.
  • System-managed fields (id, created_at, updated_at) cannot be modified.

Valid example

{
  "name": "Renamed Project"
}

Invalid example (empty body)

{}

<Note>This endpoint is in beta, read more here.</Note>

patch/v2/projects/{project_id}

Path parameters

project_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique project identifier (base64)

Request body

namestring required

New project name. Must be unique within the space.

Response

A project object

idstring required

The project ID

namestring required

The project name

space_idstring required

The space ID the project belongs to

created_atstring date-time required

When the project was created