Clerk docs

Beta Features

Modify instance settings that are currently in beta.

Update instance settings

Updates the settings of an instance

SecuritybearerAuth
Request
Request Body schema: application/json
restricted_to_allowlist
boolean or null
Default: false

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

from_email_address
string or null

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_up
boolean or null

Enable the Progressive Sign Up algorithm. Refer to the docs for more info.

session_token_template
string or null

The name of the JWT Template used to augment your session tokens. To disable this, pass an empty string.

enhanced_email_deliverability
boolean or null

The "enhanced_email_deliverability" feature will send emails from "verifications@clerk.dev" instead of your domain. This can be helpful if you do not have a high domain reputation.

test_mode
boolean or null

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

Responses
200

InstanceSettings Server API

402

Payment required

422

Invalid request parameters

patch/beta_features/instance_settings
Request samples
application/json
{
  • "restricted_to_allowlist": false,
  • "from_email_address": "string",
  • "progressive_sign_up": true,
  • "session_token_template": "string",
  • "enhanced_email_deliverability": true,
  • "test_mode": true
}
Response samples
application/json
{
  • "object": "instance_settings",
  • "id": "string",
  • "restricted_to_allowlist": true,
  • "from_email_address": "string",
  • "progressive_sign_up": true,
  • "enhanced_email_deliverability": true
}

Update production instance domainDeprecated

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

SecuritybearerAuth
Request
Request Body schema: application/json
home_url
string

The new home URL of the production instance e.g. https://www.example.com

Responses
202

Accepted

400

Request was not successful

422

Request was not successful

put/beta_features/domain
Request samples
application/json
{
  • "home_url": "string"
}
Response samples
application/json
{
  • "errors": [
    ],
  • "meta": { }
}

Update production instance domain

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

SecuritybearerAuth
Request
Request Body schema: application/json
home_url
string

The new home URL of the production instance e.g. https://www.example.com

Responses
202

Accepted

400

Request was not successful

422

Request was not successful

post/instance/change_domain
Request samples
application/json
{
  • "home_url": "string"
}
Response samples
application/json
{
  • "errors": [
    ],
  • "meta": { }
}
➔ Next to Sign-ups