View Source

You can delete a group with the removeGroup method.

Permissions to run the request: Account Owner, Administrators, Department Administrators or users with a role with custom settings allowing to delete groups.

Parameters

Parameter	Type	Description
credentials (required)	credentials	Read the description of the Credentials object.
groupId (required)	string	The ID of a group you want to delete.

Return Value

After the request has been successfully processed, the system returns an object with the following properties:

Параметр	Тип	Описание
success	bool	True if the group has been deleted.

Possible Errors

Error	Description
Permission denied	The user has no permissions to delete groups.
Wrong parameters	The group with the given ID wasn't found.

Sample Request

 <?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>
     <RemoveGroupRequest>
       <credentials>
         <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
         <email>email@email.com</email>
         <password>password</password>
       </credentials>
       <groupId>string</groupId>
     </RemoveGroupRequest>
   </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>

Пример ответа

<?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>