BRbraintrustdata
Organizations

Partially update organization

Changed on

Partially update an organization 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/organization/{organization_id}

Request

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

Path parameters

organization_idstring uuid required

Organization id

Request body

namestring nullable

Name of the organization

api_urlstring nullable
is_universal_apiboolean nullable
is_dataplane_privateboolean nullable
proxy_urlstring nullable
realtime_urlstring nullable
image_rendering_mode'auto' | 'click_to_load' | 'blocked' | 'null' nullable

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

Response

Returns the organization object

idstring uuid required

Unique identifier for the organization

namestring required

Name of the organization

api_urlstring nullable
is_universal_apiboolean nullable
is_dataplane_privateboolean nullable
proxy_urlstring nullable
realtime_urlstring nullable
createdstring date-time nullable

Date of organization creation

archived_atstring date-time nullable
deleted_atstring date-time nullable
image_rendering_mode'auto' | 'click_to_load' | 'blocked' | 'null' nullable

Controls how images are rendered in the UI: 'auto' loads images automatically, 'click_to_load' shows a placeholder until clicked, 'blocked' prevents image loading entirely

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

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • 2e0e9e00d0bdRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status