Update User Group

User Group APIs

Update User Group

OVERVIEW

Overview

Update an existing user group in Publisher

This API call is used to update an existing user group in the system, by replacing the user group with the provided user group object.

Since v4.6

HTTP Request

PUT /api/2/groups/<ID>

HTTP Request Object

User Group Object, either in JSON or XML format.

URL Parameters

Parameter	Description
ID	The ID of the user group to update

HTTP Headers

HTTP Request Header	Description	Example
Authorization	The API Authorisation token.	"Bearer XXXXXXXXXXXXX"
Accept	The format of the expected response. "application/json" "application/xml" If no parameter is set, JSON is the default response given.	"application/xml"
Content-Type	The format of the provided content. "application/json" "application/xml" If no parameter is set, JSON is the expected content by default.	"application/json"

HTTP Request Header

Description

Example

Authorization

The API Authorisation token.

"Bearer XXXXXXXXXXXXX"

Accept

The format of the expected response.

"application/json"
"application/xml"

If no parameter is set, JSON is the default response given.

"application/xml"

Content-Type

The format of the provided content.

"application/json"
"application/xml"

If no parameter is set, JSON is the expected content by default.

"application/json"

HTTP Response

Success

HTTP response 200 with User Group summary object

(Example below)

Error

See API Error messages

Example HTTP Request & Response

PUT http://example.com/context/api/2/groups/3

JSON Request

{

"group": {

"id": 3,

"name": "HighQ",

"users": [

456,

22,

98107

]

}

JSON Response

{