From Bright Pattern Documentation
Jump to: navigation, search
• 5.19 • 5.2 • 5.3 • 5.8

Delete Tenant

By default, this method deletes an inactive tenant and associated access numbers. To keep tenant access numbers disassociated from the deleted tenant, use the additional query parameter keepAccessNumbers=true.

Note that the tenant must be inactive. If it is not, you will get the 400 response indicating that the tenant is still active.


Request

URL http[s]://<host>:<port>/configapi/v2/tenant/<tenant_url>

(to delete the tenant with associated access numbers)

or

http[s]://<host>:<port>/configapi/v2/tenant/<tenant_url>?keepAccessNumbers=true

(to delete the tenant but keep the associated access numbers)

Method DELETE


Response

Code Description
200 Tenant deleted
404 Tenant not found
400 Tenant is active



< Previous | Next >
< Previous | Next >