Delete a tenant

Delete a tenant, unlinking its customers and removing its tenant fields.

Deleting a tenant unlinks it from all of its customers and removes any associated tenant fields. Threads previously linked to the tenant retain a reference to the deletion record but are no longer routed via it.

For TypeScript, the GraphQL SDK gives you a fully typed client for these operations.

A tenant is identified by either its Plain tenantId or its externalId.

This operation requires the following permissions:

• tenant:delete

Mutation

mutation deleteTenant($input: DeleteTenantInput!) {
  deleteTenant(input: $input) {
    tenant {
      id
      name
    }
    error {
      message
      type
      code
      fields {
        field
        message
        type
      }
    }
  }
}

Variables

{
  "input": {
    "tenantIdentifier": {
      "externalId": "team_123"
    }
  }
}