Update Clerk organization domain

Update enrollment mode or verification status for an organization domain.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/organization-domains/{domain_id}

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

8 tokens

Update enrollment mode or verification status for an organization domain.

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

enrollment_modestringOptional

Filter or set enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

verifiedbooleanOptional

Whether the domain is verified.

Response12 fields

domainobject

11 fields

Updated organization domain summary.

idstring

Clerk organization domain id (dmn_...).

namestring

Domain name (for example example.com).

organization_idstring

Clerk organization id (org_...) that owns this domain.

enrollment_modestring

Enrollment mode: manual_invitation, automatic_invitation, or automatic_suggestion.

affiliation_email_addressstring

Affiliation email address for the domain, when set.

ownership_verification_statusstring

DNS ownership verification status (unverified, verified, failed, or expired).

affiliation_verification_statusstring

Affiliation verification status (unverified, verified, failed, or expired).

total_pending_invitationsinteger

Number of pending invitations associated with this domain.

total_pending_suggestionsinteger

Number of pending membership suggestions associated with this domain.

created_atinteger

Unix timestamp in milliseconds when the domain was created.

updated_atinteger

Unix timestamp in milliseconds when the domain 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/organization-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

200Organization domain after update.

updated_domain.json

{
  "domain": {
    "id": "dmn_2abc123",
    "name": "example.com",
    "organization_id": "org_2xyz456",
    "enrollment_mode": "automatic_invitation",
    "affiliation_email_address": null,
    "ownership_verification_status": "verified",
    "affiliation_verification_status": "verified",
    "total_pending_invitations": 0,
    "total_pending_suggestions": 0,
    "created_at": 1710000000000,
    "updated_at": 1710000000000
  }
}