Skip to main content
POST
/
v1
/
assessment-groups
/
{assessmentGroupId}
/
members
/
batchRemove
Remove users from an Assessment Group
curl --request POST \
  --url https://client.synack.com/api/assessment/v1/assessment-groups/{assessmentGroupId}/members/batchRemove \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userUids": [
    "u_5f3c8b2a",
    "u_9e1d4f0c",
    "u_2a7b6c4d"
  ]
}
'
{
  "results": [
    {
      "userUid": "<string>",
      "errorDetail": "<string>"
    }
  ],
  "metadata": {
    "processedAt": "2023-11-07T05:31:56Z",
    "counts": {
      "added": 1,
      "removed": 1,
      "noop": 1,
      "error": 1
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
assessmentGroupId
integer
required

Numeric identifier of the Assessment Group.

Required range: x >= 1

Body

application/json
​
userUids
string[]
required
Required array length: 1 - 100 elements
Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

Batch processed. Inspect per-row status for outcomes.

​
results
object[]
required
​
metadata
object
required