You can update a group with the updateGroup method.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameters
Parameter | Type | Description |
---|
credentials (required) | credentials | Read the description of the Credentials object. |
groupId (required) | string | ID of the group that you want to update. |
name (required) | string | Name of the specified group. |
description (required) | string | Description of the specified group. |
users (optional) | string[] | Array of IDs of users that will be added to the group. |
Return Value
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 updated. |
excessUsers | string | Array of IDs of users who haven't been added to the group. |
Possible Errors
| |
---|
Unknown group | The group with the specified name was not found. |
Permission denied | You have no permissions to edit the group info. |
Wrong parameters | The system failed to process the request because it did not contain all necessary parameters. |
A group with a given name already exists. | A group with the specified name already exists. |
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>
<UpdateGroupRequest>
<credentials>
<accountUrl>http://myaccount.ispringlearn.com</accountUrl>
<email>email@email.com</email>
<password>password</password>
</credentials>
<groupId>1</groupId>
<name>Name</name>
<description>Description</description>
<users>
<id>1</id>
<id>2</id>
</users>
</UpdateGroupRequest>
</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>
<UpdateGroupResult>
<success>true</success>
<excessUsers />
</UpdateGroupResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML