Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

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);

UpdateOrganizationParams

NameTypeDescription
organizationIdstringThe organization ID of the organization being updated.
name?stringThe updated name of the organization.
slug?stringThe updated slug of the organization.
publicMetadata?Record<string, unknown>Metadata saved on the organization, that is visible to both your Frontend and Backend APIs.
privateMetadata?Record<string, unknown>Metadata saved on the organization that is only visible to your Backend API.

Last updated on August 16, 2023

What did you think of this content?

Clerk © 2024