KOkontainer
Usergroups

Update a usergroup

Please note the exemplary request body. It updates all the fields; however, if one only seeks to update a specific field (e.g., name), please omit the others.

patch/user-groups/{usergroup_id}

Request

Path parameters

usergroup_idstring required

ID of usergroup to update

Request body

Example request

{
  "data": {
    "attributes": {
      "name": "Updated usergroup name",
      "note": "Updated usergroup note",
      "active": true,
      "show_brand_section": true,
      "hide_menu_by_default": true
    }
  }
}

Response

updated

Example response

{
  "data": {
    "type": "user_group",
    "id": "55211",
    "attributes": {
      "name": "Advertisement",
      "note": "This group contains only third-party advertisement users.",
      "active": true,
      "show_brand_section": 1,
      "hide_menu_by_default": true
    }
  }
}

Changes

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