updateUserMetadata()
Updates the metadata associated with the specified user by merging existing values with the provided parameters.
A "deep" merge will be performed - "deep" means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to null.
Returns a User object.
function updateUserMetadata(userId: string, params: UpdateUserMetadataParams): Promise<User>- Name
userId- Type
string- Description
The ID of the user to update.
- Name
publicMetadata?- Type
UserPublicMetadata- Description
Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
- Name
privateMetadata?- Type
UserPrivateMetadata- Description
Metadata that can be read and set only from the Backend API.
const userId = 'user_123'
const response = await clerkClient.users.updateUserMetadata(userId, {
publicMetadata: {
example: 'metadata',
},
})Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint PATCH/users/{user_id}/metadata. See the BAPI reference for more information.
Feedback
Last updated on