clerk.update_user_metadata
Merge metadata fields for a Clerk user. Only the provided metadata keys are updated.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns the updated user summary.
Cost = 8 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user_id | Yes | Clerk user id (user_...) whose metadata to update. | |
| public_metadata | No | Public metadata fields to merge. Existing keys not listed are preserved. | |
| unsafe_metadata | No | Unsafe metadata fields to merge. Existing keys not listed are preserved. | |
| private_metadata | No | Private metadata fields to merge. Existing keys not listed are preserved. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| user | No | Updated Clerk user object after the metadata merge. |