Docs

deleteOrganization()

Deletes an Organization given a valid ID.

function deleteOrganization: (organizationId: string) => Promise<Organization>;
  • Name
    organizationId
    Type
    string
    Description

    The ID of the organization to delete.

const organizationId = 'org_2b6TtF4XlxDsKo6t0E0UyywGB72';

const response = await clerkClient.organizations.deleteOrganization(organizationId);

console.log(response);
/*
DeletedObject {
  object: 'organization',
  id: 'org_2b6TtF4XlxDsKo6t0E0UyywGB72',
  slug: null,
  deleted: true
}
*/

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/organizations/{organization_id}. See the BAPI reference for more details.

Feedback

What did you think of this content?