You can delete an organization with the removeOrganization method.
Permission to run the request: Account Owner, Administrator.
Parameters
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object. |
organizationId (required) | int | ID of the organization that you want to remove. |
Return Value
Parameter | Type | Description |
---|
success | bool | 'True' if the specified organization has been removed. |
Possible Errors
Error | Description |
---|
Permission denied | You have no permissions to delete organizations. |
Wrong parameters | The organization with the specified ID was not found or it is the default one. |
Sample Call
<?xml version="1.0" encoding="utf-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<RemoveOrganizationRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<organizationId>2</organizationId>
</RemoveOrganizationRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<successResult>
<success>true</success>
</successResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML