Update instance settings
Updates the settings of an instance
Request Body schema: application/json
| 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. |
| hibp | boolean or null Whether the instance should be using the HIBP service to check passwords for breaches |
| 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. |
| support_email | string or null |
| clerk_js_version | string or null |
| experimental_allowed_origins | Array of strings |
| cookieless_dev | boolean Deprecated Whether the instance should operate in cookieless development mode (i.e. without third-party cookies).
Deprecated: Please use |
| url_based_session_syncing | boolean Whether the instance should use URL-based session syncing in development mode (i.e. without third-party cookies). |
Accepted
Invalid request parameters
- Payload
{- "test_mode": true,
- "hibp": true,
- "enhanced_email_deliverability": true,
- "support_email": "string",
- "clerk_js_version": "string",
- "experimental_allowed_origins": [
- "string"
], - "cookieless_dev": true,
- "url_based_session_syncing": true
}- 422
{- "errors": [
- {
- "message": "string",
- "long_message": "string",
- "code": "string",
- "meta": { }
}
], - "meta": { }
}Update instance restrictions
Updates the restriction settings of an instance
Success
Payment required
- Payload
{- "allowlist": true,
- "blocklist": true
}- 200
- 402
{- "object": "instance_restrictions",
- "allowlist": true,
- "blocklist": true
}Update instance organization settings
Updates the organization settings of the instance
Success
- Payload
{- "enabled": true,
- "max_allowed_memberships": 0
}- 200
{- "object": "organization_settings",
- "enabled": true,
- "max_allowed_memberships": 0
}