Batch update user groups

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}
Close
POST /api-v1/user-group/batch

Updates multiple user groups. Returns 200 on success, or 400 if any entry fails validation.

Headers

  • WEAL-TOKEN Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID

    ID of organization, for which the operation must be performed

application/json

Body Required

  • id integer

    Entity ID. If negative value, a new entity will be created

  • type string Required

    User group type

    Values are GROUP or SUPER_GROUP.

  • name string Required

    Group name

  • description string

    Group description

  • userIds array[integer]

    User (contact) IDs directly in this group

  • groupIds array[integer]

    Nested user group IDs included in this group

  • roles array[object]

    Organization-level roles assigned to this group

    Hide roles attribute Show roles attribute object
    • id integer Required

      Role ID

  • globalRoles array[object]

    Global roles assigned to this group

    Hide globalRoles attribute Show globalRoles attribute object
    • id integer Required

      Role ID

  • isAdvanced boolean

    Whether this group uses an advanced rule expression instead of explicit member lists

  • rule string

    Advanced rule expression. Only relevant when isAdvanced is true

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • items array[object]
      Hide items attributes Show items attributes object
      • errorCode object
        Hide errorCode attributes Show errorCode attributes object
        • errorCode string

          Values are NO_ERROR, NOT_IMPLEMENTED_YET, CONTACT_NOT_FOUND, FIELD_REQUIRED, VALIDATION_ERROR, DUPLICATION_ERROR, UNIQUE_CONSTRAINT_VIOLATION, WRONG_PASSWORD_FORMAT, WRONG_PASSWORD, ACTION_DENIED, NOT_FOUND, EXPECTED_ONE_FILE, UNIQUE_VIOLATION, CONTENT_EMPTY, INVALID_TYPE, CONVERSION_ERROR, FILE_PARSE_EXCEPTION, or IN_USE.

        • errorDetailValues array[object]
          Hide errorDetailValues attributes Show errorDetailValues attributes object
          • errorCode string
          • fieldName string
          • data string
          • isSevere boolean
      • freshData

        Refreshed domain data

      • freshRow

        Refreshed table row data

      • possibleWorkflows array[object]
        Hide possibleWorkflows attributes Show possibleWorkflows attributes object
        • id integer(int64)
        • name string
      • error boolean
      • severeError boolean
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

POST /api-v1/user-group/batch 
curl \
 --request POST 'https://wyzio.app/api-v1/user-group/batch' \
 --header "Content-Type: application/json" \
 --data '[{"id":12345678,"type":"STANDARD","name":"Finance Team","description":"Users with access to finance modules","userIds":[12345678],"groupIds":[12345678],"roles":[{"id":12345678}],"globalRoles":[{"id":12345678}],"isAdvanced":false,"rule":"department == 'Finance'"}]'
Request examples 
# Headers

# Payload
[
  {
    "id": 12345678,
    "type": "STANDARD",
    "name": "Finance Team",
    "description": "Users with access to finance modules",
    "userIds": [
      12345678
    ],
    "groupIds": [
      12345678
    ],
    "roles": [
      {
        "id": 12345678
      }
    ],
    "globalRoles": [
      {
        "id": 12345678
      }
    ],
    "isAdvanced": false,
    "rule": "department == 'Finance'"
  }
]
Response examples (200) 
{
  "items": [
    {
      "errorCode": {
        "errorCode": "NO_ERROR",
        "errorDetailValues": [
          {
            "errorCode": "string",
            "fieldName": "string",
            "data": "string",
            "isSevere": true
          }
        ]
      },
      "possibleWorkflows": [
        {
          "id": 42,
          "name": "string"
        }
      ],
      "error": true,
      "severeError": true
    }
  ]
}