Skip to content

Rename a project

PATCH
/projects/{project_id}
curl --request PATCH \
--url https://api.perstat.io/projects/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example" }'

Updates the display name of a project; the name is the only updatable field. The slug stays unchanged, so existing references keep working. Empty names return 400. The change is recorded in the organization audit log. Requires project management rights. Accepts API keys with the projects:write scope, subject to current role and resource grants.

project_id
required
string
Media typeapplication/json
object
name
required
string
Examplegenerated
{
"name": "example"
}

Request succeeded. The response body contains the result.

Media typeapplication/json
object
id
required
string
name
required
string
organization_id
required
string
slug
required
string
Examplegenerated
{
"id": "example",
"name": "example",
"organization_id": "example",
"slug": "example"
}

The request is invalid. Check the supplied fields and values.

Authentication is missing or invalid.

The authenticated caller does not have permission to perform this operation.

No accessible resource matches the supplied identifier.