Remove an organization
An application owner removes an obsolete tenant from backend administration.
Clerk · Module
organizations.deleteOrganization
Deletes a specified Clerk Organization by ID and returns the deleted Organization resource.
How it works
Call the backend Organizations API with an organization ID. The asynchronous operation permanently deletes that Organization and resolves with the deleted Organization object.
Syntax
function deleteOrganization(organizationId: string): Promise<Organization>Parameters
| Name | Type | Description |
|---|---|---|
organizationId | string | The ID of the Organization to delete. |
Returns
Promise<Organization> resolving to the deleted Organization.
Key points
- The operation targets one Organization identified by its Clerk ID.
- A successful call resolves with the deleted Organization resource.
- Its signature takes a string organization ID and returns a promise of Organization.
- The organizationId parameter is the identifier used to select the resource.
- The documented invocation uses the backend clerkClient Organizations namespace.
Common mistakes
- Deletion cascades to the organization's memberships and invitations.
- This SDK method wraps Clerk's backend API; use the SDK's client-access guidance for setup.
Example: Delete an organization
const organizationId = 'org_123'
const response = await clerkClient.organizations.deleteOrganization(organizationId)Pass the organization ID to the backend Clerk client method and await the deleted Organization in the response.
When to use it
Complete tenant offboarding
A lifecycle workflow handles tenant offboarding after account closure.
Interview questions
QWhat does deleteOrganization accept and return?
It accepts one string, organizationId, and returns a Promise<Organization>. The ID identifies the Organization that Clerk should delete.
Follow-up: What HTTP operation does it represent? It wraps the BAPI DELETE /organizations/{organization_id} endpoint.
QHow do you invoke the method?
The method deletes the specified Organization through clerkClient.organizations.deleteOrganization(organizationId). The returned promise resolves to the deleted Organization.
Follow-up: How would you identify the target? Supply its Clerk Organization ID, such as org_123, rather than a display name.
QWhere should this operation be used?
It is a backend SDK operation, and the documentation points to the SDK-specific overview for how clerkClient is accessed. The call therefore belongs in code using the appropriate Clerk backend SDK setup.
Follow-up: What should be checked before shipping? Confirm the selected backend SDK's client initialization and authentication configuration.
Related
OrganizationclerkClient.organizationsBAPI endpoint DELETE/organizations/{organization_id}