Update Clerk instance restrictions

Update sign-up and sign-in restriction settings for a connected Clerk instance.

← All Clerk endpoints · Capability overview

PATCH/v1/clerk/instance-restrictions

https://api.vee3.io/v1/clerk/instance-restrictions

8 tokens

Update sign-up and sign-in restriction settings 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.update_instance_restrictions

Parameters6 fields

clerk_instance_idstringOptional

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

allowlistbooleanOptional

Whether the allowlist restriction should be enabled.

blocklistbooleanOptional

Whether the blocklist restriction should be enabled.

allowlist_blocklist_disabled_on_sign_inbooleanOptional

Whether allowlist and blocklist checks should be skipped during sign-in.

block_email_subaddressesbooleanOptional

Whether email subaddresses (plus-addressing) should be blocked.

block_disposable_email_domainsbooleanOptional

Whether disposable email domains should be blocked.

Response7 fields

restrictionsobject

6 fields

Updated Clerk instance restrictions from the Backend API.

objectstring

Clerk object type for instance restrictions.

allowlistboolean

Whether the allowlist restriction is enabled.

blocklistboolean

Whether the blocklist restriction is enabled.

allowlist_blocklist_disabled_on_sign_inboolean

Whether allowlist and blocklist checks are skipped during sign-in.

block_email_subaddressesboolean

Whether email subaddresses (plus-addressing) are blocked.

block_disposable_email_domainsboolean

Whether disposable email domains are blocked.

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-restrictions"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "allowlist": False,
    "allowlist_blocklist_disabled_on_sign_in": False,
    "block_disposable_email_domains": False
}

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

Example responses1 example

200Instance restrictions after update.

updated_restrictions.json

{
  "restrictions": {
    "object": "instance_restrictions",
    "allowlist": true,
    "blocklist": false,
    "allowlist_blocklist_disabled_on_sign_in": false,
    "block_email_subaddresses": true,
    "block_disposable_email_domains": true
  }
}