Add a new reader group

Prev Next
Post
/v2/Readers/groups
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Body parameters
ReadersGroup - Add a new readers groups with access level None.

Here you can add new readers group with access scope and access level as None.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Article.

Here you can add new readers group with access scope and access level to Article.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Category.

Here you can add new readers group with access scope and access level to Category.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Language.

Here you can add new readers group with access scope and access level to particular Language.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Project.

Here you can add new readers group with access scope and access level to Project.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Version.

Here you can add new readers group with access scope and access level to Version.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
Expand All
object
title
string Required

The name of the reader group

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

Access level of the reader group

associated_readers
Array of string | null

Description of the reader group

string
access_scope
object Required

List of reader IDs to be associated with the reader group

access_level
integer (int32) Required

This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
categories
Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object
project_version_id
string Required

The project version id to which the category belongs.

Min length1
category_id
string Required

The category id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
project_versions
Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string
languages
Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object
project_version_id
string Required

The project version id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
associated_invited_sso_users
Array of string | null

List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

string
ReadersGroup - Add a new readers groups with access level None.

Here you can add new readers group with access scope and access level as None.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Article.

Here you can add new readers group with access scope and access level to Article.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Category.

Here you can add new readers group with access scope and access level to Category.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Language.

Here you can add new readers group with access scope and access level to particular Language.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Project.

Here you can add new readers group with access scope and access level to Project.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Version.

Here you can add new readers group with access scope and access level to Version.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
Expand All
object
title
string Required

The name of the reader group

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

Access level of the reader group

associated_readers
Array of string | null

Description of the reader group

string
access_scope
object Required

List of reader IDs to be associated with the reader group

access_level
integer (int32) Required

This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
categories
Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object
project_version_id
string Required

The project version id to which the category belongs.

Min length1
category_id
string Required

The category id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
project_versions
Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string
languages
Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object
project_version_id
string Required

The project version id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
associated_invited_sso_users
Array of string | null

List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

string
ReadersGroup - Add a new readers groups with access level None.

Here you can add new readers group with access scope and access level as None.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Article.

Here you can add new readers group with access scope and access level to Article.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Category.

Here you can add new readers group with access scope and access level to Category.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Language.

Here you can add new readers group with access scope and access level to particular Language.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Project.

Here you can add new readers group with access scope and access level to Project.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Version.

Here you can add new readers group with access scope and access level to Version.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
Expand All
object
title
string Required

The name of the reader group

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

Access level of the reader group

associated_readers
Array of string | null

Description of the reader group

string
access_scope
object Required

List of reader IDs to be associated with the reader group

access_level
integer (int32) Required

This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
categories
Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object
project_version_id
string Required

The project version id to which the category belongs.

Min length1
category_id
string Required

The category id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
project_versions
Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string
languages
Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object
project_version_id
string Required

The project version id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
associated_invited_sso_users
Array of string | null

List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

string
ReadersGroup - Add a new readers groups with access level None.

Here you can add new readers group with access scope and access level as None.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Article.

Here you can add new readers group with access scope and access level to Article.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Category.

Here you can add new readers group with access scope and access level to Category.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "rffb5c7e-fcbe-4797-b144-1a7ca2508fvew",
        "category_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508f50",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Language.

Here you can add new readers group with access scope and access level to particular Language.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Project.

Here you can add new readers group with access scope and access level to Project.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": [
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd",
      "adfb5c7e-fcbe-4797-b144-1a7ca2508fdd"
    ],
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Add a new readers groups with access level to Version.

Here you can add new readers group with access scope and access level to Version.

{
  "title": "ReadersGroupName",
  "description": "For better undestanding make a breif note of readers group description.",
  "associated_readers": [],
  "access_scope": {
    "access_level": 2,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
Expand All
object
title
string Required

The name of the reader group

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

Access level of the reader group

associated_readers
Array of string | null

Description of the reader group

string
access_scope
object Required

List of reader IDs to be associated with the reader group

access_level
integer (int32) Required

This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage

Valid values[ 0, 1, 2, 3, 4, 5, 6, 7, 8 ]
categories
Array of object (CategoryScopeCustomer) | null

A list of category scope objects. This is only required if the access level is set 1 - Category

object
project_version_id
string Required

The project version id to which the category belongs.

Min length1
category_id
string Required

The category id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
project_versions
Array of string | null

A list of project versions This is only required if the access level is set to 2 - Version

string
languages
Array of object (LanguageScopeCustomer) | null

A list of language scope objects This is only required if the access level is set to 4 - Language

object
project_version_id
string Required

The project version id to which the user should be given access.

Min length1
language_code
string Required

The language to which the user should be given access.

Min length1
associated_invited_sso_users
Array of string | null

List of invitation IDs to be associated with this reader group. Applicable only for SSO readers.

string
Responses
200

Success

Readers - Success Response for add reader group

This is an example for 200 status, success response.

{
  "result": "02050a57-47e3-41b0-9f88-832c643abb8c",
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
string | null

Customer API response data

extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

Readers - Missing of Access Scope

Kindly add access_scope field as it is mandatory.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AccessScope field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Readers - Missing of Title

Kindly add title field as it is mandatory.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Title field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Readers - Title already exist

Kindly change title name as it is already exist.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Title Name already exists. Title has to be unique.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.