Remove people from group

Remove people from a group.

POST /groups/{groupId}/remove-people

Remove people from group

cURL

curl --request POST \
  --url https://api.vanta.com/v1/groups/{groupId}/remove-people \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "updates": [
    {
      "id": "<string>"
    }
  ]
}
'

200

{
  "results": [
    {
      "id": "person-id-1",
      "status": "SUCCESS"
    },
    {
      "id": "person-id-2",
      "status": "ERROR",
      "message": "Invalid Input"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

groupId · string · required

Body

application/json

updates · object[] · required

List of people IDs to remove from a group.

Required array length: 1 - 100 elements

Show child attributes

Response

200 - application/json

Ok

results · object[] · required

List of results matching the length and order of the request

Option 1

Option 2

Show child attributes