Update Organization

client.organizations.update(, , ?): Organization { id, name, created_at, 2 more }

PUT/api/v2/organizations/{organization_id}

Update an existing organization.

ParametersExpand Collapse

organizationID: string

body: OrganizationUpdateParams { name }

name: string

The organization’s new display name.

maxLength3000

minLength1

ReturnsExpand Collapse

Organization { id, name, created_at, 2 more }

API response schema for an organization.

id: string

The organization’s unique identifier.

name: string

The organization’s display name.

created_at?: string | null

Creation datetime

formatdate-time

metadata?: Record<string, unknown>

Additional organization metadata.

updated_at?: string | null

Update datetime

formatdate-time

Update Organization

import LlamaCloudAdmin from '@llamaindex/llama-cloud-admin';

const client = new LlamaCloudAdmin({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const organization = await client.organizations.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
  name: 'x',
});

console.log(organization.id);

{
  "id": "id",
  "name": "name",
  "created_at": "2019-12-27T18:11:19.117Z",
  "metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "id": "id",
  "name": "name",
  "created_at": "2019-12-27T18:11:19.117Z",
  "metadata": {
    "foo": "bar"
  },
  "updated_at": "2019-12-27T18:11:19.117Z"
}