You can delete a group with the deleteGroup method.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameter | Type | Description |
---|---|---|
credentials (required) | credentials | Read the description of the Credentials object. |
groupId (required) | string | ID of the group you want to delete. |
After the request has been completed, the system returns an object with the following properties:
Parameter | Type | Description |
---|---|---|
success | bool | 'True' if the group has been deleted. |
Error | Description |
---|---|
Unknown group | The group was not found. |
Permission denied | You have no permissions to delete the specified group. |
<?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> <DeleteGroupRequest> <credentials> <accountUrl>http://myaccount.ispringlearn.com</accountUrl> <email>email@email.com</email> <password>password</password> </credentials> <groupId>1</groupId> </DeleteGroupRequest> </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> <DeleteGroupResult> <success>true</success> </DeleteGroupResult> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |