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

You can add a group with the addGroup method.

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

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
name (required)stringThe name of the new group.
userId (optional)stringThe ID of a user.

Return Value

ParameterTypeDescription
groupIdstringThe ID of the created group.

Possible Errors

ErrorDescription
Permission deniedThe user has no permissions to add groups.
Wrong parametersThe system failed to process the request because it did not contain all necessary parameters.

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>
      <AddGroupRequest>
         <credentials>
          <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
          <email>email@email.com</email>
          <password>password</password>
         </credentials>
        <name>NEW_GROUP</name>
        <userIds>
          <id>cfe9248a-deb4-11e9-979c-0a580af40764</id>
          <id>d030ff3a-deb4-11e9-b26a-0a580af40764</id>
          <id>d07ba5f8-deb4-11e9-a6de-0a580af40764</id>
        </userIds>
      </AddGroupRequest>
  </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>
    <AddGroupResult>
      <groupId>string</groupId>
    </AddGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>



  • No labels