Update Group

Update a group's name or user attribute precedence.

Returns 400 if the group is the built-in "All Users" group, whose membership always tracks the workspace roster and can't be renamed or reweighted.

A warning is returned if the update makes this group's precedence match another group's in the workspace.

patch

/workspaces/{workspace_id}/groups/{group_id}

Authorizations

AuthorizationstringRequired

A Personal Access Token (PAT).

Path parameters

workspace_idstringRequired

group_idstringRequired

Body

namestring · nullableOptional

user_attribute_precedenceinteger · nullableOptional

Must be greater than 0; 0 is reserved for the all_users group.

Responses

200

Successful Response

application/json

4XX

Client Error

application/json

5XX

Server Error

application/json

patch/workspaces/{workspace_id}/groups/{group_id}

curl -L -X PATCH https://api-external.zenlytic.com/api/v2/workspaces/<workspace_id>/groups/<group_id> \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"name": "Sales Team", "user_attribute_precedence": 2}'

{
  "data": {
    "id": "grp_123",
    "workspace_id": "ws_456",
    "name": "Sales Team",
    "is_all_users": false,
    "user_attribute_precedence": 2,
    "users": [
      "usr_111",
      "usr_222"
    ]
  },
  "meta": {
    "status": "success",
    "errors": [],
    "warnings": []
  }
}