Skip to content

Function: archiveTeams() ​

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

Defined in: src/teams/api/teams.ts:62

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ orgId: string; teamIds: string[]; }-
parameters.orgIdstringThe ID of the organisation that owns the teams to archive.
parameters.teamIds?string[]-
options?RequestOptions-

Returns ​

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