Skip to main content

Update project

PUT <your-unleash-url>/api/admin/projects/:projectId

Authorization

name: Authorizationtype: apiKeyin: header

Update a project with new configuration. Any fields not provided are ignored.

Request

Path Parameters

  • projectId string required

Body

required

updateProjectSchema

  • name string required

    The new name of the project

  • description string

    A new description for the project

  • mode string

    Possible values: [open, protected, private]

    A mode of the project affecting what actions are possible in this project

  • defaultStickiness string

    A default stickiness for the project affecting the default stickiness value for variants and Gradual Rollout strategy

Responses

This response has no body.

Authorization

name: Authorizationtype: apiKeyin: header

Request

Base URL
<your-unleash-url>
apiKey
projectId — path required
Body required
{
"name": "my-renamed-project",
"description": "Anything related to the new UI",
"mode": "open",
"defaultStickiness": "userId"
}
curl / cURL
curl -L -X PUT '<your-unleash-url>/api/admin/projects/:projectId' \
-H 'Content-Type: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"name": "my-renamed-project",
"description": "Anything related to the new UI",
"mode": "open",
"defaultStickiness": "userId"
}'