Updates a reader group

  • Updated on Dec 24, 2024
  • 17 minute(s) read
  • Janeera D A
  • Pradeep Srinivasan
  • Manoharan Soundarraj
Put
/v2/Readers/groups/{groupId}
Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Path parameters
groupId
stringRequired

The ID of the reader group

Body parameters
ReadersGroup -Update an existing readers group with access level None.

Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Article.

Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Category.

Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4",
        "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Language.

Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Project.

Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Version.

Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "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

Description of the reader group.

associated_readers
Array of string | null

List of reader IDs to be associated with this reader group. Note: Reader IDs that were previously associated but not present in this list during the update will be dissociated from this reader group.

string
access_scope
object Required

Access level of this 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 ]
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. Note: Invitation IDs that were previously associated but not present in this list during the update will be disassociated from this reader group.

string
ReadersGroup -Update an existing readers group with access level None.

Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Article.

Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Category.

Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4",
        "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Language.

Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Project.

Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Version.

Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "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

Description of the reader group.

associated_readers
Array of string | null

List of reader IDs to be associated with this reader group. Note: Reader IDs that were previously associated but not present in this list during the update will be dissociated from this reader group.

string
access_scope
object Required

Access level of this 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 ]
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. Note: Invitation IDs that were previously associated but not present in this list during the update will be disassociated from this reader group.

string
ReadersGroup -Update an existing readers group with access level None.

Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Article.

Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Category.

Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4",
        "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Language.

Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Project.

Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Version.

Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "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

Description of the reader group.

associated_readers
Array of string | null

List of reader IDs to be associated with this reader group. Note: Reader IDs that were previously associated but not present in this list during the update will be dissociated from this reader group.

string
access_scope
object Required

Access level of this 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 ]
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. Note: Invitation IDs that were previously associated but not present in this list during the update will be disassociated from this reader group.

string
ReadersGroup -Update an existing readers group with access level None.

Here you can edit the readers group with the access permission as None. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 0,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Article.

Here you can edit the readers group with the access permission as Article. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 5,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Category.

Here you can edit the readers group with the access permission as Category. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 1,
    "categories": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca2508vr4",
        "category_id": "fc7e-fcbe-4797-b144-1a7ca2508vfe433",
        "language_code": "en"
      }
    ],
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Language.

Here you can edit the readers group with the access permission as Language. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 4,
    "categories": null,
    "project_versions": null,
    "languages": [
      {
        "project_version_id": "8dfb5c7e-fcbe-4797-b144-1a7ca250dd3e",
        "language_code": "en"
      }
    ]
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Project.

Here you can edit the readers group with the access permission as Project. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "access_scope": {
    "access_level": 3,
    "categories": null,
    "project_versions": null,
    "languages": null
  },
  "associated_invited_sso_users": null
}
ReadersGroup - Update an existing readers group with access level as Version.

Here you can edit the readers group with the access permission as Version. Also add groupId in the path to complete the request.

{
  "title": "UpdatedReadersGroupName",
  "description": "For better undestanding update and breif this group description here.",
  "associated_readers": null,
  "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

Description of the reader group.

associated_readers
Array of string | null

List of reader IDs to be associated with this reader group. Note: Reader IDs that were previously associated but not present in this list during the update will be dissociated from this reader group.

string
access_scope
object Required

Access level of this 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 ]
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. Note: Invitation IDs that were previously associated but not present in this list during the update will be disassociated from this reader group.

string
Responses
200

Success

Readers - 200 Success response for Update reader groups

This is a sample success status response example.

{
  "result": false,
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": null,
  "information": null
}
Expand All
object
result
boolean

Customer API response data

extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information

400

Bad Request

Readers - 400 response for group Id not found.

Kindly verify your group Id and perform the task again. You can verify your group Id from /v2/Readers/groups.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader group Id does not exist.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Readers - 400 response for title not found.

Here the title is an mandatory field.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The Title field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Readers - 400 response for AccessScope not found.

Here the AccessScope is an mandatory field.

{
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AccessScope field is required.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Expand All
object
extension_data
object | null

Extention data for customer API response

success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
extension_data
object | null

Thids is the Extention data object

stack_trace
string | null

Stack trace for error response message

description
string | null

Description for error cause

error_code
string | null

Error code for Api response

custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
extension_data
object | null

Extention Data for customer Api warning

description
string | null

Warning description

warning_code
string | null

warning code for customer Api base response

information
Array of object (BaseInformation) | null

Information passed by the customer API response

object
extension_data
object | null

Extention data for customer Api response information

description
string | null

status description for customer Api response information