Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
BulkTeamOperations

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 status of the operation.

post/v2/teams/bulk/remove-user

Request body

Example request

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

Response

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

bulkIdstring

Unique identifier for the bulk operation.

status'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
messagestring

Success message for the operation.