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

Delete reader group

  • Dark
    Light

DELETE /readers/groups/{groupId}

Deletes the reader group with the given ID


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.

Route Parameters

ParameterRequiredTypeDescription
groupIdYesstringThe ID of the reader to delete

Sample Response

If 'success' returns true status, then it indicates that the record has been deleted.

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

Was this article helpful?

What's Next