Projects

Partially update project

Changed on

Partially update a project object. Specify the fields to update in the payload. Any object-type fields will be deep-merged with existing content. Currently we do not support removing fields or setting them to null.

patch/v1/project/{project_id}

Request

  • Base URL
    https://api.braintrust.dev
  • Auth
    • HTTP bearer
    • or none

Path parameters

project_idstring uuid required

Project id

Request body

namestring nullable

Name of the project

descriptionstring nullable
user_idstring nullable

Response

Returns the project object

idstring uuid required

Unique identifier for the project

org_idstring uuid required

Unique id for the organization that the project belongs under

namestring required

Name of the project

descriptionstring nullable

Textual description of the project

createdstring date-time nullable

Date of project creation

deleted_atstring date-time nullable

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

user_idstring uuid nullable

Identifies the user who created the project

Changes

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property //// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property ///// became not nullable

    • breaking

      the request property became not nullable

    • breaking

      removed the enum value undefined of the request property ///////

    • info

      removed the undefined enum value from the /// response property for the response status

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status