MEmendix
groups

Edit a group

Use this operation to edit a group

  • If a field is omitted in the request body, it is not updated. To set field to empty specify with empty string.
put/groups/{groupId}

Request

  • Base URL
    https://pmp-demo.privateplatform.mendix.com/groupservice/v2
  • Auth
    • HTTP basic
    • or API key in header Authorization

Path parameters

groupIdstring required

Group Id

Request body

namestring required

Group name

descriptionstring

Group description

parentGroupNamestring required

Parent group name

Example request

{
  "name": "GroupA",
  "parentGroupName": "GroupB"
}

Response

Group

idstring

Group Id

namestring

Group name

descriptionstring

Group description

memberCountinteger

Group member count

parentGroupstring

Parent group name

Example response

{
  "id": "36279c9b-9b5a-4599-b548-7fe09d792f76",
  "name": "GroupA",
  "description": "Test group",
  "memberCount": 7,
  "parentGroup": "GroupB"
}

Changes

No recorded changes to this operation across all 1 revision of this API.