Braintest
PATCH/v1/project/{project_id}

Partially update a project

Updates selected fields of an existing project. Send only the fields you want to change; object-type fields are generally deep-merged, but a settings update replaces the existing settings, so include every setting you want to retain. You cannot remove fields or set them to null through this operation.

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

1 parameter · 2 body fields
project_idstringrequired

The project's unique identifier in UUID format.

Fields to update on the project; send only the properties you want to change, and do not use null values to remove fields.

namestringoptional

Name of the project

settingsobjectoptional

The project's settings object. A settings update replaces all existing settings, so include every setting you want to retain.

6 status codes
200Returns the updated project object, including its identifier, organization, name, timestamps, creator identifier, and current settings.
idstringrequired

Unique identifier for the project

org_idstringrequired

Unique id for the organization that the project belongs under

namestringrequired

Name of the project

createdstringoptional

Date of project creation

deleted_atstringoptional

Date of project deletion, or null if the project is still active

user_idstringoptional

Identifies the user who created the project

settingsobjectoptional
400Returned when the update payload is unacceptable, such as when it attempts to remove a field or set a value to null.
401Returned when no valid API key is provided.
403Returned when the API key does not have permission to update the project.
429Returned when too many requests reach the API too quickly.
500Returned when an internal API failure occurs.

Error handling

A 400 is returned when the update payload is unacceptable. A 401 indicates that no valid API key was provided, while a 403 indicates that the API key lacks permission; a 429 indicates excessive request frequency, and a 500 indicates an internal API failure. Do not send null values or use the settings object unless it contains every setting you want to keep.