PATCH/projects/{uuid}

Update a project

Updates a project's name or description. Provide the fields you want to change in the request body; the response includes the updated project details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
uuidstringrequired
The UUID of the project to update.

Project fields to update.

descriptionstringoptional
The description of the project.
namestringoptional
The name of the project.

5 status codes
201Returns the updated project object, including its UUID, name, and description.
descriptionstringoptional
namestringoptional
uuidstringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
404Returned when the project is not found.
messagestringoptional
422Returned when the submitted data fails validation; the response includes a message and field-level errors.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token; a 401 when authentication is missing; a 404 when the project is not found; and a 422 when the submitted data fails validation. The uuid path parameter must identify the project to update.