clerk.change_instance_domain
Change the primary or secondary home URL for a connected Clerk instance.
WARNING: Destructive operation — changing the instance domain invalidates active sessions and may cause brief downtime.
Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.
Returns whether Clerk accepted the domain change request.
Cost = 10 tokens.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| home_url | Yes | New home URL for the instance domain. | |
| is_secondary | No | When true, change the secondary domain instead of the primary. | |
| clerk_instance_id | No | Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| accepted | No | Whether Clerk accepted the domain change request. |