Method: updateGroup

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 the group you want to edit.
name (required)	string	The name of a group.

Return Value

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

Parameter	Type	Description
success	bool	True if the group was successfully edited.

Possible Errors

Type	Description
Unknown Group	The group is not found.
Permission denied	The user has no permissions to edit groups.
Wrong Parameters	The system failed to process the request because it did not contain all necessary parameters.

Sample Request

POST /api/v2/soap/2.0 https/1.1
SOAPAction: "updateGroup"

<?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>
      <UpdateGroupRequest>
        <credentials>
          <accountUrl>https://myaccount.ispringlearn.com</accountUrl>
          <email>email@mail.ru</email>
          <password>password</password>
        </credentials>
        <groupId>2bbc2ed0-8841-11e9-93c1-0242c0a85016</groupId>
        <name>Quality Assurance</name>
      </UpdateGroupRequest>
    </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>
    <updateGroupResult>
      <success>true</success>
    </updateGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

XML