Skip to content
campaiDeveloper
campai.com

Connect ยท Teams

DELETE/connect/organizations/{organizationId}/teams/{teamId}

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.remove permission.

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'

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 chatConversations record 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.deleteTeamData job is queued on DefaultQueue.
  • If the conversation exists and has cleanup pending or is being deleted, the connect.processChatCleanup job is queued on DefaultQueue.
  • If the conversation exists and has pending work, the connect.processChatWork job is queued on DefaultQueue.
  • The misc.deleteTodoItems job is queued on DefaultQueue for the team's todo items.

Errors

Other errors

StatusErrorWhen
404The team was not foundIf 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.