Skip to content

update_project

Update a project's name, description, instructions, or archive status.

Content fields (name/description/instructions) can only be changed while the project
is active — unarchive it first. To delete a project use delete_project. Requires
workspace project-edit permission.

Parameters

ParameterTypeDefaultDescription
workspace_idrequiredstring (uuid)The workspace the project belongs to.
project_idrequiredstring (uuid)The project to update.
namestring1–∞ charsNew display name, if renaming.
descriptionstring0–1000 charsNew description, if changing.
instructionsstring0–200000 charsNew project instructions, if changing.
archivedbooleanSet true to archive the project, false to unarchive. Omit to leave archive status unchanged.