Docs

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

updateOrganizationMembershipMetadata()

Updates the metadata associated with a user's organization membership.

const organizationId = 'my-organization-id';


const userId = 'my-user-id';

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

    The ID of the organization this membership belongs to.

  • Name
    userId
    Type
    string
    Description

    The user ID associated with the metadata being updated.

  • 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