AVAILABLE WITH BUSINESS SUBSCRIPTION
Method: removeGroup
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
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="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<RemoveGroupRequest>
<credentials>
<accountUrl>https://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<groupId>string</groupId>
</RemoveGroupRequest>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="https://schemas.xmlsoap.org/soap/envelope/"
xmlns="https://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<successResult>
<success>true</success>
</successResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML