Deletes a reader group
  • 09 Mar 2023
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Deletes a reader group

  • Dark
    Light

Article Summary

Delete
/v1/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
string Required

The ID of the reader group to be deleted

Responses
200

Success

Readers - Success Response for update reader

This is an example for 200 status, success response.

{
  "extension_data": null,
  "success": true,
  "errors": null,
  "warnings": null,
  "information": null
}
Expand All

object

extension_data
object


success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

extension_data
 

stack_trace
string 

Stack trace for error response message


description
string 

Description for error cause


error_code
string 

Error code for Api resonse


custom_data
object


warnings
Array of object

Warning in the customer Api response


object

extension_data
 

description
string 

Warning description


warning_code
string 

warning code for customer Api base response


information
Array of object

Information passed by the customer Api response


object

extension_data
 

description
string 

status description for customer Api response information


400

Bad Request

Readers - Success Response for update reader

Kindly verify your readers group Id. You can find your reader group Id from /v2/Readers/groups/{groupId}.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The reader group Id does not exist.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": null,
  "information": null
}
Expand All

object

extension_data
object


success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

extension_data
 

stack_trace
string 

Stack trace for error response message


description
string 

Description for error cause


error_code
string 

Error code for Api resonse


custom_data
object


warnings
Array of object

Warning in the customer Api response


object

extension_data
 

description
string 

Warning description


warning_code
string 

warning code for customer Api base response


information
Array of object

Information passed by the customer Api response


object

extension_data
 

description
string 

status description for customer Api response information



Was this article helpful?