Page tree
Skip to end of metadata
Go to start of metadata

You can edit a group with the updateGroup method.

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

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringThe ID of the group you want to edit.
name (required)stringThe name of a group.

Return Value

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

ParameterTypeDescription
successboolTrue if the group was successfully edited.

Possible Errors

TypeDescription
Unknown GroupThe group is not found.
Permission deniedThe user has no permissions to edit groups.
Wrong ParametersThe system failed to process the request because it did not contain all necessary parameters.

Sample Request

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

<?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@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>

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>
    </updateGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
  • No labels