Skip to main content
DELETE
Delete Tenant

Authorizations

Authorization
string
header
required

Pass as Bearer <API_KEY>. Get API Key from SuprSend dashboard Developers -> API Keys section.

Path Parameters

tenant_id
string
required

unique identifier of the tenant to delete

Body

application/json
children_action
enum<string>
default:orphan

Only applies when the tenant has sub-tenants. orphan (default) promotes sub-tenants to root tenants. reassign moves sub-tenants under reassign_to tenant. delete deletes every sub-tenant in the subtree. Ignored for tenants with no sub-tenants.

Available options:
orphan,
reassign,
delete
Example:

"reassign"

reassign_to
string

Target parent when children_action = reassign. Required in that case; must reference an existing tenant. See sub-tenants.

Example:

"acme-corp"

Response

204 - No Content