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
Name | Type | Description |
---|---|---|
organizationId | string | The organization ID of the organization being updated. |
name? | string | The updated name of the organization. |
slug? | string | The 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. |