Sign in

Delete Tenant

Delete a tenant by passing it's ID. Deletion does not affect in-flight notifications, which complete with the settings that were in effect at trigger time. When the tenant has sub-tenants, use children_action in the request body to control what happens to them.

delete/v1/tenant/{tenant_id}/

Path parameters

tenant_idstring required

unique identifier of the tenant to delete

Request body

children_action'orphan' | 'reassign' | 'delete'

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.

reassign_tostring

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

Example request

{
  "children_action": "reassign",
  "reassign_to": "acme-corp"
}

Response

204 - No Content

Changes

Changed in 1 of the 7 revisions of this API.2

  • ea7b2f7c41a92See the full diff
    • ○

      added optional request body

      request-body-added-optional

    • ○

      added the non-success response with the status

      response-non-success-status-added