Skip to main content
PUT
Update Organization

Authorizations

Authorization
string
header
required

Headers

TR-Organization
string<uuid>
required

The organization id to use for the request

Body

application/json

The organization data that you want to update

name
string | null

The new name of the organization. If not provided, the name will not be updated.

partner_configuration
any | null

New details for the partnership configuration. If not provided, the partnership configuration will not be updated.

Response

Updated organization object

created_at
string<date-time>
required

Timestamp of the creation of the dataset

deleted
integer<int32>
required

Flag to indicate if the organization has been deleted. Deletes are handled async after the flag is set so as to avoid expensive search index compaction.

id
string<uuid>
required

Unique identifier of the dataset, auto-generated uuid created by Trieve

name
string
required

Name of the organization

partner_configuration
any
required

Configuration of the organization for the Trieve partner program. Contact partnerships@trieve.ai for more details.

updated_at
string<date-time>
required

Timestamp of the last update of the dataset

registerable
boolean | null

Flag to indicate whether or not new users may join the organization. Default is true.