Replace Clerk user metadata

Replace a single metadata namespace for a Clerk user.

← All Clerk endpoints · Capability overview

PUT/v1/clerk/users/{user_id}/metadata/{metadata_type}

https://api.vee3.io/v1/clerk/users/{user_id}/metadata/{metadata_type}

8 tokens

Replace a single metadata namespace for a Clerk user.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.replace_user_metadata

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

user_idstringRequired

Clerk user id (user_...) whose metadata to replace.

metadata_type"public_metadata" | "private_metadata" | "unsafe_metadata"Required

Metadata namespace to replace.

metadataobjectRequired

New metadata dict that fully replaces the chosen namespace. Pass an empty object to clear all keys.

Response6 fields

userobject

5 fields

Updated Clerk user object after the metadata replacement.

idstring

Clerk user id (user_...).

first_namestring

User first name, if set.

last_namestring

User last name, if set.

primary_email_addressstring

Primary email address for the user, if available.

created_atinteger

Unix timestamp in milliseconds when the user was created.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/users/{user_id}/metadata/{metadata_type}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "metadata_type": "public",
    "metadata": {"plan":"enterprise"}
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Clerk user after a metadata namespace replacement.

replaced_metadata_user.json

{
  "user": {
    "id": "user_2abc123",
    "first_name": "Ada",
    "primary_email_address": "ada@example.com",
    "created_at": 1710000000000
  }
}