Skip to main content
DELETE
Delete Tenant

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Tenant ID

Pattern: ^[1-9]\d*$

Response

Deleted tenant

id
number
required

Tenant ID

name
string
required

Tenant name

tenantCode
string
required

Tenant code

externalBillingId
string | null
required

External billing ID

billingStartDate
string | null
required

Billing start date

conduitPrefix
string | null
required

Conduit prefix

brandId
string | null
required

Brand ID

brandVertical
string | null
required

Brand vertical

resellerType
string | null
required

Reseller type (RESELLER or WHITELABEL)

globalQueueActions
number | null
required

Global queue actions flag

queuePauseReasons
string[] | null
required

Queue pause reasons

parkinglotTimeout
number | null
required

Parking lot timeout in seconds

incomingRingsCount
number | null
required

Incoming rings count

recordingStorage
string | null
required

Recording storage type (DEFAULT or AWS3)

recordingHost
string | null
required

Recording host URL

recordingUser
string | null
required

Recording storage username

recordingPassword
string | null
required

Recording storage password

recordingDir
string | null
required

Recording storage directory

salesforceDomain
string | null
required

Salesforce domain URL

salesforceCTITasks
string | null
required

Salesforce CTI tasks setting

autoPortReject
number | null
required

Auto port reject flag

callWaiting
number | null
required

Call waiting flag

disabled
number
required

Whether tenant is disabled (1 = yes, 0 = no)

enableSoftphonePark
number | null
required

Enable softphone park flag

isResidential
number | null
required

Whether tenant is residential

mfaEnabled
number | null
required

Whether MFA is enabled

recordUserSessions
number | null
required

Whether user sessions are recorded

sameRing
number | null
required

Same ring flag

forceVoicemailPin
number | null
required

Force voicemail PIN flag

billingV2
number | null
required

Whether billing V2 is enabled

timezone
object | null
required

Timezone details

musicOnHold
object | null
required

Music on hold details

routingProfile
object | null
required

Routing profile details

partner
object | null
required

Partner details

branch
object | null
required

Default branch details

isResellerAccount
number
required

Whether this is a reseller account (1 = yes, 0 = no)

parkinglotCount
number | null
required

Number of parking lot spaces

notes
object[]
required

Account notes

products
object[]
required

Product pricing entries

integrations
object[]
required

Active integrations

billingInfo
object | null
required

Billing contact info mapped from QuickBooks customer

conduits
object[]
required

Configured conduits