Replace Clerk user phone number

Replace a Clerk user's primary phone number.

← All Clerk endpoints · Capability overview

PUT/v1/clerk/users/{user_id}/phone-number

https://api.vee3.io/v1/clerk/users/{user_id}/phone-number

8 tokens

Replace a Clerk user's primary phone number.

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_phone_number

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

phone_numberstringRequired

New phone number in E.164 format.

identification_statusstringOptional

Status for the replacement number: verified (default) or reserved.

Response6 fields

phone_numberobject

5 fields

Replacement Clerk phone number object from the Backend API.

idstring

Clerk phone number id.

phone_numberstring

Phone number in E.164 format.

verifiedboolean

Whether the phone number is verified.

reserved_for_second_factorboolean

Whether the phone number is reserved for multi-factor authentication.

default_second_factorboolean

Whether this is the user's default second factor.

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}/phone-number"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "user_id": "user_2abc123",
    "phone_number": "+15551234567"
}

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

Example responses1 example

200User phone number replaced.

phone_number_replaced.json

{
  "phone_number": {
    "id": "idn_2abc123",
    "phone_number": "+15551234567",
    "verified": true,
    "reserved_for_second_factor": false,
    "default_second_factor": false
  }
}