You can add a group with the createGroup method.

Permission to run the request: Account Owner, Administrator, Organization Administrator. 

 

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
name (required)stringName of the new group.
description (optional)stringDescription of the new group.
organizationId (optional)stringOrganization ID where the group will be created.


Return Value

After the request has been completed, the system returns an object with the following properties.

ParameterTypeDescription
groupIdstringID of the added group.


Possible Errors

ErrorDescription
Permission deniedYou have no permissions to add a group to the specified organization.
A group with a given name already existsA group with the specified name already exists.
Wrong parametersSome of the parameters are missing or incorrect.


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>
    <CreateGroupRequest>
      <credentials>
        <accountUrl>http://myaccount.ispringlearn.com</accountUrl>
        <email>email@email.com</email>
        <password>password</password>
      </credentials>
      <name>group name</name>
      <description>description</description>
    </CreateGroupRequest>
  </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>
    <CreateGroupResult>
      <groupId>1</groupId>
    </CreateGroupResult>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML