Update a project for a workspace

Since this endpoint can be used to both update and to create a project, the request body depends on the intent.

Creation

See the POST documentation for the project collection for an example of the request body.

Note: The key should not be specified in the body of request (since it is already present in the URL). The name is required, everything else is optional.

Update

See the POST documentation for the project collection for an example of the request body.

Note: The key is not required in the body (since it is already in the URL). The key may be specified in the body, if the intent is to change the key itself. In such a scenario, the location of the project is changed and is returned in the Location header of the response.

Request body

typestring required

uuidstring

The project's immutable id.

keystring

The project's key.

namestring

The name of the project.

descriptionstring

is_privateboolean

Indicates whether the project is publicly accessible, or whether it is private to the team and consequently only visible to team members. Note that private projects cannot contain public repositories.

created_onstring date-time

updated_onstring date-time

has_publicly_visible_reposboolean

Indicates whether the project contains publicly visible repositories. Note that private projects cannot contain public repositories.

Response

The existing project is has been updated.