Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringThe 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:

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

Possible Errors

Error

Description

Permission deniedThe user has no permissions to delete groups.
Wrong parametersThe group with the given ID wasn't found.


Sample Request

Code Block
languagexml
 <?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>

...