DELETE/v1/campaigns/{id}

Excluir campanha

Apaga uma campanha em draft, queued ou canceled. Campanhas que já começaram a sair não podem ser apagadas.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenchaveSecretaoptional

Stored only in this browser for the chaveSecreta security scheme and reused on every API page in this group.

Values are applied to the request and the example on the right.

idpath · integerrequired

ID da campanha, o id devolvido ao criar.

204

Campanha excluída. Sem corpo.

401application/json

Chave ausente, inválida ou revogada.

{
  "message": "Credencial ausente ou inválida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

404application/json

Não existe com esse ID neste site.

{
  "message": "Recurso não encontrado."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

409application/json

O envio já começou ou terminou, ou o status não permite a operação.

{
  "message": "A campanha não pode ser alterada no status atual."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.