Skip to main content

deleteDomain() (deprecated)

Warning

This method is deprecated. Use the delete() method instead.

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

function deleteDomain(satelliteDomainId: string): Promise<DeletedObject>

Parameters

  • Name
    satelliteDomainId
    Type
    string
    Description

    The ID of the satellite domain to delete.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.domains.deleteDomain('domain_123')

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub