You can add a user to a group by sending the POST request to the following URL: /group/<group_id>/member.
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-User-Id (required) | ID of the user, whom you want to add to the specified group. |
After the request has been completed, the system returns the response with Code 201.
Possible Response Codes
Code | Text | Description |
---|
404 | Unknown user | The specified user hasn't been found. |
404 | Unknown group | The specified group hasn't been found. |
403 | Permission denied | You do not have permission to edit the group. |
403 | User already group's member | A given user already belongs to the specified group. |
400 | Bad Request | The system failed to process the request, because it did not contain all necessary parameters. |
403 | Can't add user into group from another organization | You are not allowed to add a user into a group from another organization. |
201 | Created | A given user has been added to the specified group. |
Sample Request
POST /group/1/member 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-User-Id: 1
XML
Sample Response
HTTP/1.1 201 Created
Connection: close
XML