v1

latestOpenAPI 3.0.3BSL2026-07-17133415718.8 KB

Organization

Update Organization

Update an organization. Only the owner of the organization can update it.

put/api/organization

Headers

TR-Organizationstring uuid required

The organization id to use for the request

Request body

namestring nullable

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

{"stackTrail":"components:schemas:UpdateOrganizationReqPayload:properties:partner_configuration","oasType":"schema","type":"unknown","description":"New details for the partnership configuration. If not provided, the partnership configuration will not be updated.","nullable":true}

Response

Updated organization object

created_atstring date-time required

Timestamp of the creation of the dataset

deletedinteger 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.

idstring uuid required

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

namestring required

Name of the organization

{"stackTrail":"components:schemas:Organization:properties:partner_configuration","oasType":"schema","type":"unknown","description":"Configuration of the organization for the Trieve partner program. Contact partnerships@trieve.ai for more details."}

registerableboolean nullable

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

updated_atstring date-time required

Timestamp of the last update of the dataset

Example response

{
  "created_at": "2021-01-01 00:00:00.000",
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "name": "Trieve",
  "partner_configuration": {
    "COMPANY_NAME": "Trieve",
    "DEMO_DOMAIN": "demos.trieve.ai",
    "FAVICON_URL": "https://cdn.trieve.ai/favicon.ico"
  },
  "registerable": true,
  "updated_at": "2021-01-01 00:00:00.000"
}