> ## Documentation Index
> Fetch the complete documentation index at: https://docs.talkover.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Limpar campanha

> Encerra todas as listas de contatos da campanha sem apagar a campanha

# Limpar campanha

Encerra todas as listas de contatos ativas da campanha e, se você pedir, remove as chamadas — o mesmo que **Limpar campanha** no painel. A campanha, as configurações e o histórico de chamadas continuam.

## Endpoint

```
POST /api/v1/campaigns/{campaign_id}/clear
```

## Parâmetros de caminho

**campaign\_id** `string` *required*

UUID da campanha.

## Cabeçalhos da requisição

**Authorization** `string` *required*

Token Bearer. Formato: `Bearer talq_your_environment_token_here`

## Corpo da requisição

**export\_to\_sftp** `boolean` (default: true)

Quando a campanha tem exportação SFTP configurada, exporta os resultados antes de remover as chamadas.

**delete\_calls** `boolean` (default: false)

Remove as chamadas cujo status está em `delete_statuses`. Sem isso, as chamadas não concluídas só são paradas.

**delete\_statuses** `string[]` (default: \[])

Status a remover quando `delete_calls` é `true`: `pending`, `queued`, `processing`, `awaiting_report`, `completed`, `failed`, `canceled`, `paused`, `terminated`.

> [!WARNING]
>
> **`delete_statuses` vazio não remove nada.** Para remover as chamadas de todos os status, envie todos os status na lista.

## O que limpar faz

* Toda chamada não concluída (pendente, pausada, em processamento) é parada, então nada das listas antigas volta a ser discado. Chamadas concluídas são mantidas.
* Com `delete_calls`, as chamadas nos status escolhidos saem da campanha. Elas ficam ocultas, não destruídas: gravação, transcrição e cobrança continuam.
* Números removidos podem ser importados de novo na hora. **Isso também zera o período de espera deles**: um número que já concluiu uma chamada pode ser ligado de novo pela próxima lista.
* A resposta volta quando as listas estão encerradas. Só a exportação SFTP, quando configurada, roda depois.

## Exemplos

```bash theme={null}
curl -X POST "https://app.talkover.ai/api/v1/campaigns/campaign-uuid/clear" \
  -H "Authorization: Bearer talq_your_environment_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "delete_calls": true,
    "delete_statuses": ["pending", "queued", "processing", "awaiting_report", "completed", "failed", "canceled", "paused", "terminated"]
  }'
```

## Resposta

```json theme={null}
{
  "success": true,
  "data": {
    "files_cleared": 1,
    "files_failed": 0,
    "completed_calls": 15204,
    "terminated_calls": 3138,
    "leftover_calls_deleted": 0,
    "sftp_export_queued": false
  },
  "message": "Campaign cleared. 1 files cleared, 15204 completed, 3138 terminated."
}
```

## Respostas de erro

### 500 — Limpeza parcial

Pelo menos uma lista não pôde ser encerrada (`files_failed` > 0) e continua ativa. **Não suba a próxima lista ainda**: envie a limpeza de novo — ela só mexe nas listas que continuam ativas.

```json theme={null}
{
  "success": false,
  "data": { "files_cleared": 2, "files_failed": 1, "completed_calls": 9120, "terminated_calls": 410, "leftover_calls_deleted": 0, "sftp_export_queued": false },
  "message": "Campaign partially cleared: 1 list(s) failed. Retry the clear before uploading."
}
```

### 404 — Campanha não encontrada

A campanha não existe ou pertence a outro ambiente.

## Ciclo diário

Para trocar o mailing de uma campanha todo dia por script:

1. **Limpar**: `POST /campaigns/{campaign_id}/clear`. Em `500`, repita até voltar `200`.
2. **Subir**: `POST /campaigns/{campaign_id}/files` com o CSV novo. Em `422`, corrija o arquivo — nada foi importado.
3. **Acompanhar**: `GET /campaigns/{campaign_id}/files/{file_data_id}/progress` a cada poucos segundos até `completed` ou `failed`.

Para mailings entregues como arquivo, a [importação SFTP](https://docs.talkover.ai/api-reference/endpoints/trigger-campaign-sftp-import) faz o mesmo sem upload HTTP.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.