v2

latestOpenAPI 3.0.02026-08-073221853.1 MB

Settings

Update Project Settings

post/console/v1/settings/project

Request body

namestring required

The name of the project.

visibility'OPEN' | 'CLOSED' | 'EXTERNAL' required

The visibility type of the project.

default_unit_typestring

The default unit ID type of the project for newly created gates, experiments, and metrics. If not provided, there will be no default unit type.

Response

Update Project Settings Response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Settings read successfully.",
  "data": {
    "name": "Test Project",
    "visibility": "closed",
    "default_unit_type": "stable_id"
  }
}