Delete a directory | Clerk API (unofficial showcase)

1 parameter

directory_idstringrequired

The ID of the directory to delete

4 status codes

200Deleted Object

objectstringrequired

idstringoptional

slugstringoptional

deletedbooleanrequired

external_idstringoptional

401Authentication invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

403Authorization invalid

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

404Resource not found

errorsarray<object>required

metaobjectoptional

clerk_trace_idstringoptional

Error handling

A 401 is returned: Authentication invalid. A 403 is returned: Authorization invalid. A 404 is returned: Resource not found.

import { Client } from "@octridev/clerk";

const client = new Client({
  baseUrl: "https://api.clerk.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.directories.delete({ directoryId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "example_value",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "slug": "my-example-resource",
  "deleted": true,
  "external_id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors