project.update

Beta

This endpoint is in beta and may not be available for all organizations.

Updates a project's title or description, including archived projects.
Requires at least one editable field. Omitted fields remain unchanged; null or empty descriptions clear the existing content.
The effective actor must have permission to edit the project, including for authorized on-behalf-of requests.
Author, confidentiality, archive state, candidate memberships, and custom fields are preserved. Missing historical required custom fields do not block edits.

Requires the projectsWrite permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the project to update.

string
length ≥ 1

The project's title.

ProjectDescriptionInput | null

Omit to preserve the description. Null or empty content clears it. Plain-text whitespace is preserved.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json