Update Clerk domain

Update a custom domain on a connected Clerk instance.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/domains/{domain_id}

https://api.vee3.io/v1/clerk/domains/{domain_id}

8 tokens

Update a custom domain on 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.update_domain

Parameters4 fields

clerk_instance_idstringOptional

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

domain_idstringRequired

Clerk organization domain id (dmn_...) to update, delete, or verify.

namestringOptional

Updated domain hostname.

proxy_urlstringOptional

Updated proxy URL for a satellite domain.

Response13 fields

domainobject

12 fields

Updated Clerk domain from the Backend API.

objectstring

Clerk object type for the domain.

idstring

Clerk domain id.

namestring

Domain hostname.

is_satelliteboolean

Whether this is a satellite domain.

frontend_api_urlstring

Frontend API URL for the domain.

accounts_portal_urlstring

Accounts portal URL for the domain.

proxy_urlstring

Proxy URL when using a satellite domain behind a reverse proxy.

development_originstring

Development origin associated with the domain.

cname_targetsarrayitems

3 fields

CNAME records required to verify the domain.

hoststring

DNS host label for the CNAME record.

valuestring

DNS target value for the CNAME record.

requiredboolean

Whether this CNAME record is required for domain verification.

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/domains/{domain_id}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "domain_id": "dmn_2abc123"
}

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

Example responses1 example

200Custom domain after update.

updated_domain.json

{
  "domain": {
    "object": "domain",
    "id": "dmn_2abc123",
    "name": "auth.example.com",
    "is_satellite": false,
    "frontend_api_url": "https://clerk.example.com",
    "accounts_portal_url": "https://accounts.example.com",
    "proxy_url": null,
    "development_origin": null,
    "cname_targets": [
      {
        "host": "clerk",
        "value": "frontend-api.clerk.services",
        "required": true
      }
    ]
  }
}