Add User Group

User Group APIs

Add User Group

OVERVIEW

Overview

Add a new user group to Publisher

This API call is used to add a new user group object to the system.

Since v4.6

HTTP Request

POST /api/2/groups

HTTP Request Object

User Group Object, either in JSON or XML format.

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

POST http://example.com/context/api/2/groups

JSON Request

{

"group": {

"name": "HighQ",

"users": [

456,

22,

98107

]

}

JSON Response

{

"group": {

"id": 3,