Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

updateOrganizationMetadata()

Updates the metadata associated with the specified organization ID.

const organizationId = 'my-organization-id'; const update = clerkClient.organizations.updateOrganizationMetadata(organizationId, { publicMetadata:{ "example": "metadata" } });

UpdateOrganizationMetadataParams

NameTypeDescription
organizationIdstringThe ID of the organization to update.
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 September 6, 2023

What did you think of this content?

Clerk © 2024