Skip to content

Update a project's name and description

PATCH
/api/v1/projects/{projectIdOrKey}
curl --request PATCH \
--url https://app.avera.io/api/v1/projects/example \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "description": "example" }'
projectIdOrKey
required
string
Media typeapplication/json
object
name
string | null
description
string | null

Example generated

{
"name": "example",
"description": "example"
}

OK

Media type*/*
object
id
required
string format: uuid
key
required
string
name
required
string
description
string | null
status
required
string
Allowed values: ACTIVE ARCHIVED TEMPLATE
templateId
string | null
defaultBranchId
string | null format: uuid
isDefault
required
boolean
createdAt
required
string format: date-time
createdBy
required
string format: uuid
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid