updateOrganization()
Updates an organization given a valid organization ID. Throws an error if the organization ID is invalid.
const organizationId = 'my-organization-id';
const name = 'my-organization-name';
const organization = await clerkClient.organizations.updateOrganization(organizationId, name);- Name
organizationId- Type
string- Description
The organization ID of the organization being updated.
- Name
name?- Type
string- Description
The updated name of the organization.
- Name
slug?- Type
string- Description
The updated slug of the organization.
- Name
publicMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the organization, that is visible to both your Frontend and Backend APIs.
- Name
privateMetadata?- Type
Record<string, unknown>- Description
Metadata saved on the organization that is only visible to your Backend API.
Feedback
Last updated on