Docs

You are viewing an archived version of the docs.Go to latest version

updateOrganizationMetadata()

Updates the metadata associated with the specified organization ID.

const organizationId = 'my-organization-id';

const update = clerkClient.organizations.updateOrganizationMetadata(organizationId, {
  publicMetadata:{
    "example": "metadata"
  }
});
  • Name
    organizationId
    Type
    string
    Description

    The ID of the organization to update.

  • 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

What did you think of this content?

Last updated on