Update reader
  • 22 Mar 2022
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update reader

  • Dark
    Light

PUT /readers/{readerId}

Updates a reader in the project


Header

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

Route Parameters

ParameterRequiredTypeDescription
readerIdYesstringThe ID of the reader to update

Body Parameters

ParameterRequiredTypeDescription
associated_reader_groups
Yes
Yes
List of reader group IDs. If the value is null or not given, then the reader would be removed from all associated reader groups.
access_scope
Yes
object
Access scope of this reader.
first_nameNostringThe first name of the reader.
last_nameNostringThe last name of the reader.
is_invitation_idNoboolApplicable only for Single Sign-On readers. Set this property to true, if the reader is a Single Sign-On reader who hasn't logged in to the application yet.

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

{
	"first_name": "Samuel",
	"last_name": "Paul",
	"associated_reader_groups": [
		"1903764b-dfac-4bc4-b10a-ec10219485d3"
	],
	"access_scope": {
		"access_level": 3
	},
	"is_invitation_id": false
}

Sample Response

If success returns true status, then it indicates that the operation is successful.

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

Was this article helpful?

What's Next