Page tree
Skip to end of metadata
Go to start of metadata

You can edit a group by sending the POST request with the XML data to the following URL:  /group/{group_id}.

Permissions to run the request: Account OwnerAdministratorsDepartment Administrators or users with a role with custom settings allowing to edit groups. 

Request Headers

Parameter

Description

X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com.
X-Auth-Email (required)The login of Account OwnerAdministratorsDepartment Administrators or a user with a role with custom settings allowing to edit groups. 
X-Auth-Password (required)

The password of Account OwnerAdministratorsDepartment Administrators or a user with a role with custom settings allowing to edit groups. 

group_id (required)The ID of a group you want to edit.
name (optional)The name you want to assign to a group.

Response Codes

Code

Text

Description

200Successful operationThe parameter is successfully updated.
400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission deniedThe user doesn't have enough permissions to update a group. 

Sample Request

POST /group/b1496214-acab-11e9-8db0-120a62f268a9/ HTTP/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>    
</request>

Sample Response

HTTP/1.1 200 Successful operation
Connection: close
  • No labels