Edit group

Request description

Endpoint: /users/groups/:id/update
Method: PATCH

The following parameter must be passed through the URL:

• id: specifies the unique group identifier
  

Header

{
  "Content-Type": "application/json",
  "Authorization": "Bearer <accessToken>"
}

Note: the <accessToken> is obtained as a result of the authentication

Payload

{
  "name": "mock-group"
}

Payload structure

type EditUserPayloadType = {
  name: string // group name
}

Responses

Correct response

{
  // empty response
}

Wrong responses

{
  // empty body
}

Description: this error occurs when endpoint authorizers fail to validate the token sent in the request header.

{
  // empty body
}

Description: this error occurs when a group not found.

type EditUserResponseType = {
    errorType: UPDATE_GROUP_ERROR_TYPE,
    errorMessage?: string
}

enum Edit_USER_ERROR_TYPE {
  GROUP_NAME_ALREADY_EXISTS= 'groupNameAlreadyExists',
  REQUIRED_GROUP_NAME = 'requiredGroupName',
  INVALID_GROUP_ID = 'invalidGroupId'
}