Campanhas
Cancelar os jobs pendentes da campanha
Cancela os jobs ainda pendentes da campanha.
API key
Escopo write
Exemplo de requisição
curl -X DELETE "https://seu-dominio/campaigns/:id" \
-H "x-api-key: $VERTICE_API_KEY"
const response = await fetch('https://seu-dominio/campaigns/:id', {
method: 'DELETE',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
},
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Cancela os jobs ainda pendentes da campanha. Mensagens já enviadas não são desfeitas.
Cada destinatário vira um job independente na fila da instância. O progresso é calculado por status e o cancelamento afeta apenas jobs pendentes.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
Path
id
string
obrigatório
ID da campanha.
Contrato
204
Resposta
A operação responde 204 sem corpo.
Erros comuns
400
Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401
Credencial ausente, inválida ou sessão expirada.
403
Escopo insuficiente, IP não autorizado ou workspace suspenso.
404
Recurso não encontrado ou pertence a outro workspace.
429
Fila cheia, limite de tentativas ou rate limit.