Remove users from teams in bulk

This endpoint removes multiple users from their respective teams in a single request. Each removal specifies the team ID and user ID. Use the Retrieve bulk team operation status endpoint to check the

Remove users from teams in bulk

post

This endpoint removes multiple users from their respective teams in a single request. Each removal specifies the team ID and user ID. Use the Retrieve bulk team operation status endpoint to check the status of the operation.

Authorizations

AuthorizationstringRequired

For accessing the API a valid JWT jwt must be passed in all queries in the 'Authorization' header. The following syntax must be used in the 'Authorization' header. (Bearer xxx.yyy.zzz)

Body

Responses

200

The bulk remove operation has been submitted. Use BulkTeamStatus to check progress.

application/json

bulkIdstringOptional

Unique identifier for the bulk operation.

messagestringOptional

Success message for the operation.

statusstring · enumOptionalDefault: BULK_OPERATION_SUBMITTEDPossible values:

400

There was a problem with input.

application/json

401

Login failed or token not valid.

application/json

403

Access denied due to insufficient permissions.

application/json

default

An unexpected error response.

application/json

post/v2/teams/bulk/remove-user

POST /v2/teams/bulk/remove-user HTTP/1.1
Host: auth.<env>.citrusad.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "removeUsers": [
    {
      "teamId": "team-456",
      "userId": "user-456"
    }
  ]
}

{
  "bulkId": "text",
  "message": "text",
  "status": "BULK_OPERATION_SUBMITTED"
}