---
updatedAt: 2026-07-28T19:33:42.000Z
---

# (Beta) Update a user group

Update an existing user group.<br><br><a href="https://api.solace.dev/cloud/reference/authentication">Token Permissions</a>: [ <code>iam_user_group:write</code> ]

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Platform",
    "description": "# REST API Concepts\n\nSolace PubSub+ Platform provides RESTful APIs that you can use to manage your data in PubSub+ Cloud. The REST APIs allow\nyou to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use. Please note that these APIs are in the Early\nAccess release stage and are available for testing and early user feedback. The APIs are subject to change until they\nare declared Generally Available.",
    "version": "2.2.2"
  },
  "servers": [
    {
      "url": "https://api.solace.cloud",
      "description": "Solace PubSub+ Cloud US EAST Region"
    },
    {
      "url": "https://api.solacecloud.com.au",
      "description": "Solace PubSub+ Cloud AU Region"
    },
    {
      "url": "https://api.solacecloud.eu",
      "description": "Solace PubSub+ Cloud EU Region"
    },
    {
      "url": "https://api.solacecloud.sg",
      "description": "Solace PubSub+ Cloud SG Region"
    }
  ],
  "security": [
    {
      "APIToken": []
    }
  ],
  "tags": [
    {
      "name": "User Groups"
    }
  ],
  "paths": {
    "/api/v2/platform/userGroups/{id}": {
      "put": {
        "tags": [
          "User Groups"
        ],
        "summary": "(Beta) Update a user group",
        "description": "Update an existing user group.<br><br><a href=\"https://api.solace.dev/cloud/reference/authentication\">Token Permissions</a>: [ <code>iam_user_group:write</code> ]",
        "operationId": "updateUserGroup",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The unique identifier for the user group.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "default": "",
              "example": "11edc73b-f324-3ef8-9635-e17383261a4e"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserGroupRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/UserGroupResponseEnvelope"
                }
              }
            }
          },
          "400": {
            "description": "Bad request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "Bad request.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              },
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "An authentication error occurred.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "You do not have permissions to perform this operation.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "404": {
            "description": "Not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse",
                  "additionalProperties": {
                    "default": ""
                  },
                  "default": ""
                },
                "example": {
                  "message": "Could not find service 4o5kyf4x5504.",
                  "errorId": "618e2fb0-a198-4d9d-9219-13e51ef0ecec"
                }
              }
            }
          },
          "502": {
            "description": "Bad Gateway - Marketplace integration error.",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorResponse": {
        "type": "object",
        "default": null,
        "properties": {
          "message": {
            "type": "string",
            "default": "",
            "description": "A user-friendly message that describes the error.",
            "example": "An error occurred."
          },
          "errorId": {
            "type": "string",
            "default": "",
            "description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
            "example": "123e4567-e89b-12d3-a456-426655440000"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {},
            "default": "",
            "description": "The metadata about the error. This provides additional information about the error that occurred.",
            "example": "'object': { 'field': 'description' }"
          },
          "validationDetails": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "default": "",
            "description": "When applicable, these are the details of issues with the fields provided for the REST call.",
            "example": "'name': ['Not unique']"
          }
        }
      },
      "UserGroupRequest": {
        "type": "object",
        "default": null,
        "properties": {
          "name": {
            "type": "string",
            "default": "",
            "description": "The name of the user group.",
            "example": "MyCustomServiceRoleEditor",
            "maxLength": 50,
            "minLength": 1
          },
          "description": {
            "type": "string",
            "default": "",
            "description": "A description of the user group.",
            "example": "This group can modify event broker services and event meshes.",
            "maxLength": 255,
            "minLength": 0
          },
          "roles": {
            "type": "array",
            "default": "",
            "description": "A collection of unique identifiers representing the roles assigned to the user group.",
            "example": "event-portal-user",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        },
        "required": [
          "name"
        ]
      },
      "UserGroupResponse": {
        "type": "object",
        "default": null,
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "default": "",
            "description": "The unique identifier for the user group."
          },
          "organizationId": {
            "type": "string",
            "default": "",
            "description": "The unique identifier for the account (organization)."
          },
          "name": {
            "type": "string",
            "default": "",
            "description": "The name of the user group."
          },
          "description": {
            "type": "string",
            "default": "",
            "description": "A description of the user group."
          },
          "roles": {
            "type": "array",
            "default": "",
            "description": "A collection of unique identifiers representing the roles assigned to the user group.",
            "items": {
              "type": "string"
            },
            "uniqueItems": true
          }
        }
      },
      "UserGroupResponseEnvelope": {
        "type": "object",
        "properties": {
          "data": {
            "$ref": "#/components/schemas/UserGroupResponse"
          },
          "meta": {
            "type": "object",
            "additionalProperties": {},
            "default": "",
            "description": "<p>The metadata about the response, which can include:</p><ul><li>Pagination data, such as page number, page size, etc. for GET operations that return large amount of response data. For more information, see <a href=\"./pagination\">Pagination</a>.</li><li>Timestamp information, such as current time, or the time create or update operation occurred for CREATE, PUT, POST operations.</li></ul>"
          },
          "included": {
            "type": "array",
            "items": {}
          }
        }
      }
    },
    "securitySchemes": {
      "APIToken": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      }
    }
  }
}
```