user-site

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

Show example

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
}

Collapse 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 (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

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_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

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
}

Collapse 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 (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

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_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

associated_invited_sso_users

Array of string | null

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
}

Collapse 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 (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

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_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

associated_invited_sso_users

Array of string | null

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
}

Collapse 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 (AddUpdateAccessScopeCustomerV2)Required

The access scope of the user

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_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

associated_invited_sso_users

Array of string | null

string

Responses

200

400

Show example

Success

Collapse all

object

result

boolean

Customer API response data

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

Show example

Bad Request

Collapse all

object

extension_data

object (ExtensionDataObject)

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object