Skip to content

Function: removeMembers() ​

ts
function removeMembers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  errors: object[];
}>;

Defined in: src/teams/api/teamMembers.ts:55

The account IDs specified will be removed from the team.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ members: object[]; orgId: string; teamId: string; }-
parameters.membersobject[]-
parameters.orgId?stringThe ID of the organisation of the team you are removing members from.
parameters.teamId?stringThe ID of the team you are removing members from.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; errors: object[]; }>