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.
The ID of the reader group
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
}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
}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
}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
}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
}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
}The name of the reader group.
Description of the reader group.
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.
Access level of this reader group.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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.
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
}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
}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
}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
}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
}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
}The name of the reader group.
Description of the reader group.
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.
Access level of this reader group.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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.
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
}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
}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
}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
}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
}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
}The name of the reader group.
Description of the reader group.
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.
Access level of this reader group.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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.
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
}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
}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
}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
}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
}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
}The name of the reader group.
Description of the reader group.
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.
Access level of this reader group.
This is an enum. Possible values are 0 - None 1 - Category 2 - Version 3 - Project 4 - Lanaguage
A list of category scope objects. This is only required if the access level is set 1 - Category
The project version id to which the category belongs.
The category id to which the user should be given access.
The language to which the user should be given access.
A list of project versions This is only required if the access level is set to 2 - Version
A list of language scope objects This is only required if the access level is set to 4 - Language
The project version id to which the user should be given access.
The language to which the user should be given access.
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.
Success
This is a sample success status response example.
{
"result": false,
"extension_data": null,
"success": true,
"errors": null,
"warnings": null,
"information": null
}Customer API response data
Extension data for customer API response
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.
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.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Bad Request
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
}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
}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
}Extension data for customer API response
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.
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.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
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.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
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.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.