Create User Group

Create a user group for the client account.

post

Body

application/jsontext/jsonapplication/*+json

namestringOptional

descriptionstring | nullableOptional

logostring | nullableOptional

accountall ofOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

HTTPcURLJavaScriptPython

POST /public/v1/accounts/user-groups HTTP/1.1
Host: api.s1.today
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "name": "text",
  "description": "text",
  "logo": "text",
  "account": {
    "id": "text"
  },
  "modules": [
    {
      "id": "text"
    }
  ],
  "buyers": [
    {
      "id": "text"
    }
  ]
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2025-08-29T18:07:57.905Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2025-08-29T18:07:57.905Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "description": "text",
  "account": {
    "id": "text",
    "icon": "text",
    "type": "Client",
    "status": "Active",
    "name": "text"
  },
  "modules": [
    {
      "id": "text",
      "description": "text",
      "name": "text",
      "filters": {
        "group.buyers": [
          "text"
        ]
      },
      "settings": {
        "configurable": true,
        "default": true,
        "paid": true,
        "type": [
          "text"
        ],
        "obsolete": true,
        "eligibility": {
          "multi": true,
          "single": true
        }
      }
    }
  ],
  "logo": "text",
  "isDefault": true,
  "users": [
    {
      "id": "text",
      "icon": "text",
      "name": "text"
    }
  ],
  "buyers": [
    {
      "id": "text",
      "icon": "text",
      "name": "text"
    }
  ]
}