Skip to main content

deleteTeam

client.swarm.deleteTeam(swarmId: string, teamId: string): Promise<void>

Delete a team from a swarm.

Permanently removes a team and all its associated memberships. Agents will be unassigned from the team but remain in the swarm.

Parameters

ParameterTypeRequiredDescription
swarmIdstringYesThe unique identifier of the swarm
teamIdstringYesThe unique identifier of the team to delete

Returns

Promise<void> — A promise that resolves when the team is deleted

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.swarm.deleteTeam('swarmId', 'teamId');
console.log(result);