Skip to content
Docs
Organizations

Delete organization by ID or label

Delete organization by ID or label

client.organizations.delete(stringorganizationID, OrganizationDeleteParams { xClientRequestID } params?, RequestOptionsoptions?): void
DELETE/organizations/{organization_id}

Deletes the organization and all zones.

ParametersExpand Collapse
organizationID: string

Organization ID or label identifier

minLength1
maxLength255
params: OrganizationDeleteParams { xClientRequestID }
xClientRequestID?: string

Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

Delete organization by ID or label

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI({
  apiKey: process.env['KEYCARD_API_API_KEY'], // This is the default and can be omitted
});

await client.organizations.delete('x');
Returns Examples