Change Clerk instance domain

Change the primary or secondary home URL for a connected Clerk instance.

← All Clerk endpoints · Capability overview

POST/v1/clerk/instance/change-domain

https://api.vee3.io/v1/clerk/instance/change-domain

10 tokens

Change the primary or secondary home URL for a connected Clerk instance.

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.change_instance_domain

Parameters3 fields

clerk_instance_idstringOptional

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

home_urlstringRequired

New home URL for the instance domain.

is_secondarybooleanOptional

When true, change the secondary domain instead of the primary.

Response1 field

acceptedboolean

Whether Clerk accepted the domain change request.

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/instance/change-domain"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "home_url": "https://auth.example.com"
}

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

Example responses1 example

200Domain change request accepted by Clerk.

domain_change_accepted.json

{
  "accepted": true
}