Sidebar

api:usergroup:update

Table of Contents

update()

Available since version: 1.8
The method is used to control user group attributes.

Parameters

ParameterTypeOptionalDescriptionDetails
user group attributeany Yes New value for a user group attribute.

Returns

ParameterDescription
resultOperation successful. Result will contain array of updated User group IDs.
errorIn case of any errors

Example

Rename user group:

  {
   "jsonrpc":"2.0",
   "method":"usergroup.update",
   "params":[
		{"usrgrpid": "100100000000042", "name": "Rename 1"},
		{"usrgrpid": "100100000000013", "name": "Rename 2"}
	],
   "auth":"700ca65537074ec963db7efabda78259",
   "id":2
  }

Retrieved updated user IDs:

  {
    "jsonrpc":"2.0",
    "result": {
	"usrgrpids":["100100000000042","100100000000013"]
    },
    "id":2
  }