Update a project

Update a project in your workspace. Projects are top-level folders that typically encompass a single use case. Use this endpoint to change a project’s name and description. You can’t use this endpoint to convert a folder into a project or a project into a folder.

NOTE: The project name can’t contain a slash or backslash.

Path parameters

idstringRequired
The ID of the project you plan to update.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional
Name to update.
descriptionstringOptional
Description to update.

Response

Details of the updated project
idinteger or null
The unique identifier of the project.
descriptionstring or null
The updated description of the project.
folder_idinteger or null
The unique identifier of the folder associated with the project.
namestring or null
The updated name of the project.

Errors