---
agentTools:
  projectIndex: https://developers.uberflip.com/llms.txt
---

# Update User Group

This endpoint updates the details of a User Group.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Uberflip API",
    "version": "2.1",
    "description": "Uberflip API",
    "contact": {
      "name": "Uberflip",
      "url": "https://developers.uberflip.com/",
      "email": "contact@uberflip.com"
    }
  },
  "servers": [
    {
      "url": "https://v2.api.uberflip.com"
    }
  ],
  "tags": [
    {
      "name": "USER GROUPS"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "paths": {
    "/user-groups/{groupId}": {
      "patch": {
        "tags": [
          "USER GROUPS"
        ],
        "summary": "Update User Group",
        "operationId": "update-user-group",
        "description": "This endpoint updates the details of a User Group.",
        "parameters": [
          {
            "name": "groupId",
            "in": "path",
            "description": "The unique identifier of the User Group",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "The User Group name."
                  },
                  "description": {
                    "type": "string",
                    "description": "The User Group description."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/listusergroups"
                },
                "examples": {
                  "Result": {
                    "value": {
                      "id": 2074237,
                      "code": null,
                      "name": "Test group",
                      "description": "Test desc",
                      "user_count": 0,
                      "lock_update": 0,
                      "lock_delete": 0,
                      "lock_grant_revoke_global_permissions": 0,
                      "lock_grant_revoke_licenses": 0,
                      "lock_add_remove_users": 0,
                      "created_at": "2022-03-23T22:26:16-0400",
                      "modified_at": "2022-03-23T22:26:16-0400"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "Access token from /authorize endpoint"
      }
    },
    "schemas": {
      "listusergroups": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The user group identifier"
          },
          "code": {
            "type": "string",
            "description": "The user group code",
            "nullable": true
          },
          "name": {
            "type": "string",
            "description": "The user group name"
          },
          "description": {
            "type": "string",
            "description": "The user group description",
            "nullable": true
          },
          "user_count": {
            "type": "integer",
            "description": "The number of users included in the user group"
          },
          "lock_update": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1,
            "description": "The user group cannot be updated if this lock is set"
          },
          "lock_delete": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1,
            "description": "The user group cannot be deleted if this lock is set"
          },
          "lock_grant_revoke_global_permissions": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1
          },
          "lock_grant_revoke_licenses": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1
          },
          "lock_add_remove_users": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1,
            "description": "Users cannot be removed from this user group if this lock is set"
          },
          "created_at": {
            "type": "string",
            "description": "The user group creation time",
            "format": "date-time"
          },
          "modified_at": {
            "type": "string",
            "description": "The user group last updated",
            "format": "date-time"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 99,
      "1": 151,
      "2": 113,
      "3": 115,
      "4": 165,
      "5": 253,
      "6": 73,
      "7": 0,
      "8": 113,
      "9": 158,
      "10": 39,
      "11": 103
    }
  }
}
```