Skip to main content
Docs
Dashboard

deleteDomain()

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

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

Parameters

  • Name
    id
    Type
    string
    Description

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

Example

Note

Importing clerkClient varies based on your framework. Refer to the Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

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?
Edit this page on GitHub

Last updated on