Connect ยท Teams
Delete team
Deletes a team in the specified organization using organizationId and teamId, or retries cleanup if the team was already deleted. It queues cleanup of subteams and associated data and returns no response body.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access and the
team.removepermission.
Request
Path parameters
-
organizationIdidrequired -
teamIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request DELETE 'https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID", {
method: "DELETE",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'DELETE',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/connect/organizations/YOUR_ORGANIZATION_ID/teams/YOUR_TEAM_ID', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
No response body is specified.
What else happens
- If the team is not already removed, its cleanup status is set to pending.
- If the team is not already removed, it is deleted and the Connect user organization cache is cleared for its contacts.
- A matching
chatConversationsrecord is marked for deletion and cleanup, if one exists. - If the conversation exists, its next work attempt time is also updated, subject to its revision remaining unchanged.
- The
connect.deleteTeamDatajob is queued onDefaultQueue. - If the conversation exists and has cleanup pending or is being deleted, the
connect.processChatCleanupjob is queued onDefaultQueue. - If the conversation exists and has pending work, the
connect.processChatWorkjob is queued onDefaultQueue. - The
misc.deleteTodoItemsjob is queued onDefaultQueuefor the team's todo items.
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | The team was not found | If the team is not found in the specified organization, the endpoint returns HTTP 404 NOT_FOUND with key routes.connect.teams.notFound. |
Errors nearly every request can meet are listed under Errors.