AVAILABLE WITH BUSINESS SUBSCRIPTION
Request: POST /group
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles.
Header | Description |
---|
X-Auth-Account-Url (required) | The base URL of the account, e.g. https://myaccount.ispringlearn.com. |
X-Auth-Email (required) | The login of Account Owner, Administrators, Department Administrators or a user with a role with custom settings allowing to add groups. |
X-Auth-Password (required) | The password of Account Owner, Administrators, Department Administrators or a user with a role with custom settings allowing to add groups. |
Parameter | Description |
---|
name (required) | The name of the group. |
userIds (optional) | The IDs of the users who will be included in the group. |
Response Codes
Code | Text | Description |
---|
201 | Created | A new group has been added. The body of the response contains ID of the added group. |
400 | Bad Request | Some of the sent parameters are incorrect. |
401 | Unauthorized | An authorization error. |
403 | Permission denied | The user doesn't have enough permissions to add groups. |
Sample Request
POST /group https/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
Content-Type:application/xml
<?xml version="1.0" encoding="UTF-8"?>
<request>
<name>New Hires</name>
<userIds>
<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
<id>9265e422-deb9-11e9-b4d0-864db459a4d7</id>
</userIds>
</request>
XML
Sample Response
https/1.1 201 Created
<?xml version="1.0" encoding="UTF-8"?>
<response>b1496214-acab-11e9-8db0-120a62f268a9</response>
XML