Share via

Hosted Exchange::DeleteBusinessOrganization

  • Article

Deletes a business organization, de-allocates mailbox resources, marks the organization deleted in the plan database, and records a billing event.

This procedure will fail with an error if any users still exist in the organization.

Arguments

Input argument Required Description

<path>

Yes

LDAP path of the organization to delete.

<preferredDomainController>

Yes

<deleteSMTPDomain>

No

If present delete SMTP Domain from recipient policies.

<SMTPDomain>

No

The organizations primary SMTP domain. If not provided, the primary SMTPDomain stored in the Customer Plan Database is used. In general this parameter should only be used for special cases where the default behavior needs to be overridden.

Remarks

Provisioning Steps

  1. Hosted Exchange::DeleteCustomerRecord_ - marks the customer record and all associated customer assets with a status of Deleted.

  2. Hosted Exchange::DeleteOrganization_ - Private procedure that removes Exchange Virtual Directories, deletes SMTPDomain recipient policy if specified, deallocates the organization from resource management, and deletes the OU.

Security

  • Impersonate caller.

  • Caller tested for UserCreator role.

Sample Code

Example XML Request

<request>   
        <procedure>     
                <execute namespace="Hosted Exchange" procedure="DeleteBusinessOrganization" impersonate="1">       
                        <executeData>         
                                <path>LDAP://OU=alpineskihouse,OU=Reseller1,OU=Hosting,DC=fabrikam,DC=Com</path>         
                                <preferredDomainController>AD01.fabrikam.com</preferredDomainController>         
                                <SMTPDomain>alpineskihouse.com</SMTPDomain>         
                                <deleteSMTPDomain/>       
                        </executeData>       
                        <after source="executeData" destination="data" mode="merge"/>     
                </execute>   
        </procedure> 
</request>

Example XML Response

No example XML response.

Applies To

Hosted Exchange Namespace API for:

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

See also

Tasks

Hosted Exchange::CreateBusinessOrganization
Hosted Exchange::DeleteBusinessUser