Post
/v1/Readers/groups

Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Body parameters

Details of new reader group

Collapse all

object

title
string   Required 

The name of the reader group.

Max length50
Min length1
Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
description
string 

Description of the reader group.


associated_readers
Array of string

List of reader IDs to be associated with this reader group.


access_scope
object

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

title
string   Required 

The name of the reader group.

Max length50
Min length1
Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
description
string 

Description of the reader group.


associated_readers
Array of string

List of reader IDs to be associated with this reader group.


access_scope
object

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

title
string   Required 

The name of the reader group.

Max length50
Min length1
Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
description
string 

Description of the reader group.


associated_readers
Array of string

List of reader IDs to be associated with this reader group.


access_scope
object

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Collapse all

object

title
string   Required 

The name of the reader group.

Max length50
Min length1
Pattern^[^~`!@#$%^&*)(+=|\]\[{};:?/>'.,]*$
description
string 

Description of the reader group.


associated_readers
Array of string

List of reader IDs to be associated with this reader group.


access_scope
object

access_level
integer   Required 

Valid values[0,1,2,3,4,5]
categories
Array of string

List of category scope objects. The field is required when access_level is set to 1-Category


project_versions
Array of string

List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.


Responses
200

Success

Collapse all

object

data
object

id
string 


extension_data
object

context
object

success
boolean 


errors
Array of object


object

warnings
Array of object


object

information
Array of object


object

feature_explorer_status
object