Update a project by ID or name

Update an existing project with new configuration. Project names cannot be changed. The project identifier is either project ID or project name. Note: When using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

PUT /v1/projects/{project_identifier}

Try it

Update a project by ID or name

cURL

curl --request PUT \
  --url https://api.example.com/v1/projects/{project_identifier} \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>"
}
'

200

{
  "data": {
    "name": "<string>",
    "id": "<string>",
    "description": "<string>"
  }
}

Path Parameters

project_identifier · string · required

The project identifier: either project ID or project name. If using a project name, it cannot contain slash (/), question mark (?), or pound sign (#) characters.

Body

application/json

description · string | null

Response

200

application/json

The updated project

data · Project · object · required

Show child attributes

data. name · string · required

Minimum string length: 1

data. id · string · required

data. description · string | null