You can add a group with the createGroup 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. |
name (required) | string | Name of the new group. |
description (optional) | string | Description of the new group. |
organizationId (optional) | string | Organization ID where the group will be created. |
Return Value
After the request has been completed, the system returns an object with the following properties.
Parameter | Type | Description |
---|
groupId | string | ID of the added group. |
Possible Errors
Error | Description |
---|
Permission denied | You have no permissions to add a group to the specified organization. |
A group with a given name already exists | A group with the specified name already exists. |
Wrong parameters | Some 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