Update Group

This method allows you to update one or more groups. It requires groupname to be updated and allows you to update description or assign profile and configuration settings to the group. It is required to provide complete details of group (description, profile name, configuration name etc) each time this update request is sent. If configuration name or profile name is not provided during update, it is understood that configuration or profile is to be unassigned from that group.

KeyMeaningMandatoryData Type
groupnameExisting group name to be updated.Yesstring
newgroupnameNew group name to rename the group. If not provided, group name remains unchanged.Nostring
groupdescUpdated group description. Complete details must be provided in each update request. If not provided, it is understood description is to be unassigned/cleared.Nostring
profilenameProfile name to assign to the group. If not provided, it is understood that profile is to be unassigned from the group.Nostring
confignameConfiguration name to assign to the group. If not provided, it is understood that configuration is to be unassigned from the group.Nostring
Query Params
string
required

Account name used to identify the User

Body Params
request
object
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json