Update reader
  • 27 Nov 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Update reader

  • Dark
    Light

PUT/readers

Updates a reader in the project


Parameter Type Description
api_token string REST API key you can obtain from Settings > Advanced > API tokens.

Body Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
reader_id string The ID of the reader
associated_reader_groups string[] List of reader group IDs. If value is null or not given, then the reader would be removed from all associated reader groups.
access_scope object Access scope of this reader.

Body Parameters > access_scope

Parameter Type Description
access_level number The access level for the reader. 0-None, 1-Category, 2-Version, 3-Project.
categories string[] List of category IDs the reader has access to. Mandatory when access_level is 1-Category.
project_versions string[] List of project version IDs the reader has access to. Mandatory when access_level is 2-Version.

Sample Request

{
  "reader_id": "samuel.paul@document360.com",
  "associated_reader_groups": [
    "bb88841d-fac4-4a73-b106-4c5fcdd58ffe"
  ]  
}

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