Instance Settings

Update instance restrictions

Updates the restriction settings of an instance

patch/instance/restrictions

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/instance/restrictions
  • Auth: HTTP bearer

Request body

allowlistboolean nullable
blocklistboolean nullable
allowlist_blocklist_disabled_on_sign_inboolean nullable
block_email_subaddressesboolean nullable
block_disposable_email_domainsboolean nullable

Response

Success

object'instance_restrictions' required

String representing the object's type. Objects of the same type share the same value.

allowlistboolean required
blocklistboolean required
allowlist_blocklist_disabled_on_sign_inboolean required
block_email_subaddressesboolean required
block_disposable_email_domainsboolean required

Changes

No recorded changes to this operation across all 49 revisions of this API.