Update Project Name

PATCH

/api/data/projects/{project_id}/name

curl --request PATCH \
  --url https://example.com/api/data/projects/example/name \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Update the project’s display name. Requires membership in the project.

Parameters

Path Parameters

project_id

required

Project Id

string

Request Body^required

Media typeapplication/json

UpdateProjectNameRequest

object

name

required

Name

string

Example^generated

{
  "name": "example"
}

Responses

200

Successful Response

Media typeapplication/json

UpdateProjectNameResponse

object

project_id

required

Project Id

Canonical external string ID (UUID-like)

string

name

required

Name

Updated project name

string

Example^generated

{
  "project_id": "example",
  "name": "example"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}