Clerk API (unofficial showcase)
PATCH/instance/restrictions

Update instance restrictions

Updates the restriction settings that control allowlisting, blocklisting, and email address checks for an instance. Supply the boolean settings you want to change; the response contains the resulting restriction configuration.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Instance restriction settings to update. All fields are optional.

allowlistbooleanoptional
Whether to enable the allowlist.
blocklistbooleanoptional
Whether to enable the blocklist.
allowlist_blocklist_disabled_on_sign_inbooleanoptional
Whether allowlist and blocklist checks are disabled during sign-in.
block_email_subaddressesbooleanoptional
Whether to block email addresses that use subaddresses.
block_disposable_email_domainsbooleanoptional
Whether to block email addresses from disposable domains.

3 status codes
200Returns the instance restriction object with the current allowlist, blocklist, sign-in, and email restriction settings.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:instance_restrictions
allowlistbooleanrequired
blocklistbooleanrequired
allowlist_blocklist_disabled_on_sign_inbooleanrequired
block_email_subaddressesbooleanrequired
block_disposable_email_domainsbooleanrequired
402Returned when payment is required to update the instance restrictions.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Returned when one or more supplied restriction settings are invalid.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 402 is returned when payment is required for the requested operation. A 422 is returned when a supplied restriction setting is invalid; each provided setting must be a boolean.