Pular para o conteúdo principal
DELETE
/
api
/
v1
/
campaigns
/
{campaign_id}
# Requisição 1: Excluir uma campanha específica
curl -X DELETE "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
  -H "Authorization: Bearer talq_your_environment_token_here"

{
  "success": true,
  "message": "Campanha excluída com sucesso"
}

​
Excluir Campanha

Excluir uma campanha específica permanentemente. Esta operação remove a campanha e todos os dados associados, incluindo configurações, estatísticas e histórico de chamadas.

​
Endpoint

DELETE /api/v1/campaigns/{campaign_id}

​
Parâmetros de caminho

​
campaign
string
obrigatório
O identificador único da campanha. Você pode encontrá-lo na lista de campanhas.

​
Cabeçalhos da requisição

​
Authorization
string
obrigatório
Token Bearer para autenticação. Formato: Bearer talq_your_environment_token_here

​
Exemplos de Requisição

# Requisição 1: Excluir uma campanha específica
curl -X DELETE "https://app.talkover.ai/api/v1/campaigns/campaign-uuid-1" \
  -H "Authorization: Bearer talq_your_environment_token_here"

# Requisição 2: Excluir campanha com ID específico
curl -X DELETE "https://app.talkover.ai/api/v1/campaigns/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer talq_your_environment_token_here"

​
Resposta

​
Resposta de Sucesso (200 OK)

{
  "success": true,
  "message": "Campanha excluída com sucesso"
}

​
Campos da Resposta

​
success
boolean
obrigatório
Indica se a operação foi bem-sucedida.
​
message
string
obrigatório
Mensagem de sucesso descrevendo a operação.

​
Respostas de erro

​
404 Não Encontrado

{
  "success": false,
  "message": "Campaign not found"
}

​
409 Conflito

{
  "success": false,
  "message": "Cannot delete campaign with active calls"
}

​
401 Não Autorizado

{
  "success": false,
  "message": "Unauthorized"
}

​
500 Erro do Servidor

{
  "success": false,
  "message": "Internal server error."
}

​
Códigos de erro

CódigoDescriçãoStatus HTTP
CAMPAIGN_NOT_FOUNDCampanha especificada não existe404
CAMPAIGN_HAS_ACTIVE_CALLSCampanha tem chamadas ativas e não pode ser excluída409
INVALID_TOKENToken de autenticação inválido ou ausente401
SERVER_ERRORErro interno do servidor ocorreu500

​
Regras de Exclusão

Campanhas em rascunho. Campanhas com status draft podem ser excluídas a qualquer momento.
Campanhas ativas. Campanhas com status active só podem ser excluídas se não tiverem chamadas em andamento.
Campanhas pausadas. Campanhas com status paused podem ser excluídas se não tiverem chamadas ativas.
Campanhas concluídas. Campanhas com status completed podem ser excluídas a qualquer momento.
Campanhas canceladas. Campanhas com status cancelled podem ser excluídas a qualquer momento.
Operação irreversível. Esta operação exclui permanentemente a campanha e todos os dados associados.

​
Notas Importantes

Perda de dados. Todos os dados da campanha serão perdidos permanentemente.
Verificação de chamadas. O sistema verifica se há chamadas ativas antes de permitir a exclusão.
Limpeza automática. Dados relacionados como arquivos e estatísticas são removidos automaticamente.
Confirmação necessária. Certifique-se de que deseja excluir a campanha antes de executar esta operação.

​
Melhores Práticas

  1. Confirme a exclusão - Certifique-se de que deseja excluir a campanha permanentemente
  2. Verifique chamadas ativas - Certifique-se de que não há chamadas em andamento
  3. Faça backup - Considere fazer backup dos dados importantes antes da exclusão
  4. Teste em ambiente de desenvolvimento - Teste a exclusão em ambiente de desenvolvimento primeiro
  5. Monitore impacto - Acompanhe como a exclusão afeta outros sistemas integrados

​
Endpoints relacionados

  • Listar Campanhas: GET /api/v1/campaigns
  • Criar Campanha: POST /api/v1/campaigns
  • Obter Campanha: GET /api/v1/campaigns/{campaign_id}
  • Atualizar Campanha: PUT /api/v1/campaigns/{campaign_id}
  • Atualizar Status da Campanha: PATCH /api/v1/campaigns/{campaign_id}/status
  • Fazer Chamada de Campanha: POST /api/v1/campaigns/{campaign_id}/call