Update reader group
  • 02 Feb 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update reader group

  • Dark
    Light

PUT /readers/groups/{groupId}

Updates a reader group.


Header

ParameterTypeDescription
api_tokenstringYou can get the REST API from Settings > Advanced > API tokens.

Route Parameters

ParameterRequiredTypeDescription
groupIdYesstringThe ID of the reader group.

Body Parameters

ParameterRequiredTypeDescription
titleYesstringThe name of the reader group.
access_scope
Yesobject
Access scope of this reader group.
descriptionNostringDescription of the reader group.
associated_readersNostring[]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 disassociated from this reader group.
associated_invited_sso_users
No
string[]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.

Body Parameters > access_scope

ParameterRequiredTypeDescription
access_levelYesnumberThe access level for the reader. 0-None, 1-Category, 2-Version, 3-Project, 4-Language
categoriesConditionallyobject[]List of category scope objects. The field is required when access_level is set to 1-Category
project_versionsConditionally
string[]List of project version IDs the reader has access to. Mandatory when access_level is set to 2-Version.
languagesConditionally
object[]List of language scope objects. The field is required when access_level is set to 4-Language.

Body Parameters > access_scope > categories

ParameterRequiredTypeDescription
category_idYesstringThe category id to which the user should be given access.
project_version_idYesstringThe project version id to which the category belongs.
language_codeYesstringThe language to which the user should be given access.

Body Parameters > access_scope > languages

ParameterRequiredTypeDescription
project_version_idYesstringThe project version id to which the user should be given access.
language_codeYesstringThe language to which the user should be given access.

Sample Request

Giving access to specific project versions.

{
	"title": "Students",
	"description": "Reader group for students",
	"associated_readers": [
		"9951f2e4-4fe3-47b9-b099-1aab99e1de76",
		"d7c9a42c-a1c8-40ed-bcaa-02110227b758"
	],
	"access_scope": {
		"access_level": 2,
		"project_versions": [
			"a928fc89-66d5-4a0c-b962-8fcb1db4dbd6",
			"a507ffa2-25a4-468a-a51a-a2d1644046ae"
		]
	}
}

Sample Response

{
  "extension_data": null,
  "context": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Was this article helpful?