You can update a group by sending the POST request to the following URL: /group/<group_id>.
Permission to run the request: Account Owner, Administrator, Organization Administrator.
Parameter | Description |
---|
X-Auth-Account-Url (required) | Base URL of the account, e.g. http://myaccount.ispringlearn.com |
X-Auth-Email (required) | Administrator e-mail address. |
X-Auth-Password (required) | Administrator password. |
X-Name (required) | A name of the specified group. |
X-Description (optional) | A description of the specified group. |
X-Users (optional) | comma-separated list of user IDs to be added to the group. |
After the request has been completed, the system returns the response with Code 200. The body of the response may contain the X-Excess-Users header with a comma-separated list of user IDs, who were not added to the group.
Possible Response Codes
Code | Text | Description |
---|
404 | Unknown group | The group with the specified name was not found. |
403 | Permission denied | You have no permission to edit the group info. |
400 | Bad Request | The system failed to process the request, because it did not contain all necessary parameters. |
403 | A group with a given name already exists. | A group with the specified name already exists. |
200 | Ok | The specified group has been updated. |
Sample Request
POST /group/1 HTTP/1.1
Host: api.ispringonline.com
X-Auth-Account-Url: http://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password
X-Name: Group Name
X-Description: description
X-Users: 1,2,3
XML
Sample Response
HTTP/1.1 200 OK
Connection: close
XML