Beta Features

Update instance settings

Changed on

Updates the settings of an instance

patch/beta_features/instance_settings

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/beta_features/instance_settings
  • Auth: HTTP bearer

Request body

restricted_to_allowlistboolean nullable

Whether sign up is restricted to email addresses, phone numbers and usernames that are on the allowlist.

from_email_addressstring nullable

The local part of the email address from which authentication-related emails (e.g. OTP code, magic links) will be sent. Only alphanumeric values are allowed. Note that this value should contain only the local part of the address (e.g. foo for foo@example.com).

progressive_sign_upboolean nullable

Enable the Progressive Sign Up algorithm. This feature is deprecated, please contact support if you need assistance.

test_modeboolean nullable

Toggles test mode for this instance, allowing the use of test email addresses and phone numbers. Defaults to true for development instances.

Response

InstanceSettings Server API

object'instance_settings'

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

idstring
restricted_to_allowlistboolean
from_email_addressstring
progressive_sign_upboolean
enhanced_email_deliverabilityboolean

Deprecated. This setting is retired and no longer affects email delivery; all email is sent through the instance's configured email sending domain. The field is preserved for API compatibility only and will be removed in a future version.

Changes