PUT/beta_features/domainDeprecated

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.

Returns 403 domain_managed_by_integration for applications in a Vercel-managed workspace; change the domain from the Vercel integration instead.

2 body fields

home_urlstringoptional

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

is_secondarybooleanoptional

Whether the domain is a secondary app.

4 status codes

202Accepted

400Request was not successful

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Request was not successful

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

422Request was not successful

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 403 is returned: Request was not successful. A 422 is returned: Request was not successful.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.domain.update({
  homeUrl: "https://api.example.com/v1",
  isSecondary: true,
});

{
  "errors": [
    {
      "message": "This is an example message.",
      "long_message": "example_value",
      "code": "123456"
    }
  ],
  "clerk_trace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors