Skip to main content
Docs

deleteDomain()

Deletes a satellite domain for the instance. It is currently not possible to delete the instance's primary domain. Returns a .

function deleteDomain(id: string): Promise<DeletedObject>
  • Name
    id
    Type
    string
    Description

    The ID of the domain that will be deleted. Must be a satellite domain.

Note

Importing clerkClient varies based on your framework. Refer to the for usage details, including guidance on .

const id = 'test_123'

const response = await clerkClient.users.deleteDomain(id)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/domains/{domain_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on