Skip to main content
DELETE
Deletando uma instância

Conceituação

Método utilizado para deletar uma instância vinculada à sua conta. Para deletar várias de uma vez, use Deletando instâncias em lote.
Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato: Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.
A exclusão é definitiva e não pode ser desfeita.

Regras de elegibilidade

Uma instância só é deletada quando atende a todas as condições abaixo:
  • Está desconectada do WhatsApp e do celular.
  • Está com a assinatura cancelada. Instâncias pagas, pendentes, com boleto pendente, em processo de cancelamento ou em retentativa de pagamento não são elegíveis.
  • Não está em trial. Um trial precisa expirar naturalmente ou ser cancelado antes.
  • Já passou da carência de 40 dias contados da data de cancelamento da assinatura.

Atributos

string
obrigatório
Token de parceiro no formato Bearer <Partner-Token>

Path

string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.

Response

204

A instância foi deletada. A resposta não tem corpo.

400

A instância não atende às regras de elegibilidade. O campo message informa o motivo.
Mensagens possíveis:

401

O header Authorization não foi enviado ou o Token de Parceiro é inválido.

404

Não existe instância para o par instanceId e token informado.

405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o DELETE conforme especificado no início deste tópico.

415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.