Replace Clerk user email address

Replace a Clerk user's email addresses with a single verified primary email.

← All Clerk endpoints · Capability overview

PUT/v1/clerk/users/{user_id}/email-address

https://api.vee3.io/v1/clerk/users/{user_id}/email-address

8 tokens

Replace a Clerk user's email addresses with a single verified primary email.

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_email_address

Parameters3 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_...) to retrieve or modify.

email_addressstringRequired

New primary email address for the user.

Response9 fields

email_addressobject

8 fields

New primary Clerk email address summary.

idstring

Clerk email address id (idn_...).

user_idstring

Clerk user id (user_...) that owns this email address.

email_addressstring

Email address value.

verification_statusstring

Verification status (e.g. verified, unverified, failed).

verifiedboolean

Whether the email address is verified.

primaryboolean

Whether this is the user's primary email address.

created_atinteger

Unix timestamp in milliseconds when the email address was created.

updated_atinteger

Unix timestamp in milliseconds when the email address was last updated.

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}/email-address"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "email_address": "ada@example.com"
}

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

Example responses1 example

200Clerk user primary email replaced.

replaced_email_address.json

{
  "email_address": {
    "id": "idn_2abc123",
    "user_id": "user_2abc123",
    "email_address": "new-primary@example.com",
    "verification_status": "verified",
    "verified": true,
    "primary": true,
    "created_at": 1710086400000,
    "updated_at": 1710086400000
  }
}