Update instance settings
Updates the settings of an instance
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. |
| 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. |
InstanceSettings Server API
Payment required
Invalid request parameters
- Payload
{- "restricted_to_allowlist": false,
- "from_email_address": "string",
- "progressive_sign_up": true,
- "session_token_template": "string",
- "enhanced_email_deliverability": true,
- "test_mode": true
}- 200
- 402
- 422
{- "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.
Request Body schema: application/json
| home_url | string The new home URL of the production instance e.g. https://www.example.com |
Accepted
Request was not successful
Request was not successful
- Payload
{- "home_url": "string"
}- 400
- 422
{- "errors": [
- {
- "message": "string",
- "long_message": "string",
- "code": "string",
- "meta": { },
- "clerk_trace_id": "string"
}
], - "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.
Request Body schema: application/json
| home_url | string The new home URL of the production instance e.g. https://www.example.com |
| is_secondary | boolean Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and will be stored as part of the domain. This is useful for supporting multiple apps (one primary and multiple secondaries) on the same root domain (eTLD+1). |
Accepted
Request was not successful
Request was not successful
- Payload
{- "home_url": "string",
- "is_secondary": true
}- 400
- 422
{- "errors": [
- {
- "message": "string",
- "long_message": "string",
- "code": "string",
- "meta": { },
- "clerk_trace_id": "string"
}
], - "meta": { }
}