Patch User Group

PATCH /user-groups/{id}

Bearer auth

This API call enables partial updates to a user group without providing the entire user group definition.

Path parameters

id integer Required

User group ID.

Responses

200 application/json

Success Response
Hide response attributes Show response attributes object
- id integer
  
  Unique identifier of user group
- name string
  
  Name of user group.
- status string
  
  Status of user group processing.
- message string
  
  Status message of user group processing.
400 application/json

Failed Response
Hide response attributes Show response attributes object
- id integer
  
  Unique identifier of user group
- name string
  
  Name of user group.
- status string
  
  Status of user group processing.
- message string
  
  Status message of user group processing.
401 application/json

Authentication Error. Invalid credentials.
Hide response attributes Show response attributes object
- code string
- message string
- description string
403

Authorization Error. Invalid role for request.
404 application/json

Failed Response

PATCH /user-groups/{id}

curl \
 --request PATCH 'https://localhost:8080/user-groups/1' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "id": 12,
  "name": "Rec Reviewers",
  "status": "Success",
  "message": "User group updated successfully."
}

Response examples (400)

{
  "status": "Failure",
  "messages": [
    "Name already exists.",
    "Invalid value for DepartmentId. Allowable values: AA."
  ]
}

Response examples (401)

{
  "code": "900901",
  "message": "Invalid Credentials",
  "description": "Access failure for API: /api/admin/v1.1.0, version: v1.1.0 status: (900901) - Invalid Credentials. Make sure you have provided the correct security credentials"
}

Response examples (404)

{
  "error": "User group not found",
  "status": 404
}