Update User Group

Update a user group.

put

Path parameters

idstringrequired

Body

application/jsontext/jsonapplication/*+json

namestringoptional

descriptionstring | nullableoptional

logostring | nullableoptional

modulesany[]optional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.platform.softwareone.com/public/v1/accounts/user-groups/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "logo": "text",
    "modules": []
  }'

application/jsontext/jsonapplication/*+json

200

400

404

200

{
  "id": "text",
  "audit": {},
  "$meta": {},
  "href": "text",
  "name": "text",
  "description": "text",
  "account": {},
  "modules": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "description": "text",
      "isConfigurable": true,
      "isEnabledByDefault": true,
      "paid": true,
      "name": "text",
      "accountTypes": [
        "text"
      ]
    }
  ],
  "logo": "text",
  "isDefault": true,
  "users": [
    {
      "id": "text",
      "audit": {},
      "$meta": {},
      "href": "text",
      "email": "text",
      "status": "text",
      "phone": {},
      "firstName": "text",
      "lastName": "text",
      "icon": "text",
      "lastLoginAt": "2025-04-03T02:37:26.311Z",
      "settings": {},
      "name": "text",
      "accounts": [
        {
          "id": "text",
          "audit": {},
          "$meta": {},
          "href": "text",
          "externalId": "text",
          "externalName": "text",
          "type": {},
          "status": {},
          "serviceLevel": {},
          "address": {},
          "icon": "text",
          "technicalSupportEmail": "[e-mail]",
          "website": "text",
          "description": "text",
          "name": "text",
          "groups": [
            "[Circular Reference]"
          ],
          "buyers": [
            {
              "id": "text",
              "audit": {},
              "$meta": {},
              "href": "text",
              "contact": {},
              "externalIds": {},
              "status": {},
              "icon": "text",
              "address": {},
              "taxId": "text",
              "account": {},
              "name": "text",
              "sellers": [
                {
                  "id": "text",
                  "audit": {},
                  "$meta": {},
                  "href": "text",
                  "externalId": "text",
                  "status": {},
                  "icon": "text",
                  "currencies": [
                    "text"
                  ],
                  "address": {},
                  "name": "text"
                }
              ]
            }
          ]
        }
      ],
      "currentAccount": {}
    }
  ]
}

Success