updateOrganizationMetadata()
Updates the metadata attributes of an Organization by merging existing values with the provided parameters. Metadata values will be updated via a "deep" merge - "deep" meaning that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to null.
function updateOrganizationMetadata(
organizationId: string,
params: UpdateOrganizationMetadataParams,
): Promise<Organization>- Name
organizationId- Type
string- Description
The ID of the organization to update.
- Name
publicMetadata?- Type
OrganizationPublicMetadata- Description
Metadata that can be read from both the Frontend API and Backend API, but can be set only from the Backend API .
- Name
privateMetadata?- Type
OrganizationPrivateMetadata- Description
Metadata that is only visible to your Backend API.
const organizationId = 'org_123'
const response = await clerkClient.organizations.updateOrganizationMetadata(organizationId, {
publicMetadata: {
example: 'metadata',
},
})Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint PATCH/organizations/{organization_id}/metadata. See the BAPI reference for more information.
Feedback
Last updated on