Embedded APIResourcesProjects

Update a project

Update a project within a customer workspace. Projects are top-level folders that typically encompass a single use case. Use this endpoint to modify a project’s name and/or description. The project name cannot include the forward slash or backward slash characters.

FOLDER AND PROJECT CONVERSION: You can’t use this endpoint to convert a folder into a project or a project into a folder.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

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