BRbraintrustdata
ProjectGroups

Partially update project group

Changed on

Partially update a project group 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_group/{project_group_id}

Request

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

Path parameters

project_group_idstring uuid required

ProjectGroup id

Request body

namestring nullable

Name of the project group

descriptionstring nullable

Textual description of the project group

add_member_projectsstring[] nullable

A list of project IDs to add to the project group

remove_member_projectsstring[] nullable

A list of project IDs to remove from the project group

Response

Returns the project group object

idstring uuid required

Unique identifier for the project group

org_idstring uuid required

Unique id for the organization that the project group belongs under

It is forbidden to change the org after creating a project group

user_idstring uuid nullable

Identifies the user who created the project group

createdstring date-time nullable

Date of project group creation

namestring required

Name of the project group

descriptionstring nullable

Textual description of the project group

deleted_atstring date-time nullable

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

member_projectsstring[] required

Sorted ids of active projects in this project group. Modifying membership requires project_group:update on the group.

Changes

  • 8f5039399f77Revision 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

  • e05ef145579dRevision changes
    • info

      endpoint added