Skip to main content
DELETE
Delete Tenant

When to use it

  • Offboarding – a customer has churned and you need to remove their data
  • Environment teardown – delete test or staging tenants
  • Compliance – right-to-deletion requests under GDPR or similar
This operation is irreversible. Deleting a tenant permanently removes:
  • Graph database storage
  • Vector store collections (knowledge and memory)
  • Source documents
  • Chunk data
  • Tenant metadata schema
  • Tenant ID mapping
This data cannot be recovered.

Endpoint

  • Auth: Bearer token
  • Idempotency: Re-sending for a deleted tenant returns 404 TENANT_NOT_FOUND
  • Async: Yes – returns deletion_scheduled. Cleanup runs in the background.

Example

Query parameters

Response

Behavior notes

Cleanup is asynchronous. Deletion runs in the background and is typically complete within a few minutes. Treat deletion as eventually consistent.
Re-creation. Once deletion is scheduled, re-creating a tenant with the same tenant_id may fail until cleanup completes. If you need to re-create immediately, use a different tenant_id.

Errors

Common codes: 400 INVALID_PARAMETERS, 404 TENANT_NOT_FOUND. See Error Responses for the full list.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

tenant_id
string
required

Unique identifier for the tenant/organization

Example:

"tenant_1234"

Response

Successful Response

tenant_id
string
required

Identifier provided by user

Example:

"tenant_1234"

status
string
default:deletion_scheduled
message
string
default:Tenant deregistered. Background cleanup is in progress.