Pular para o conteúdo
Referência da APIInstânciasdelete-instance
INSTÂNCIAS

Excluir instância

Exclua a instância selecionada e seu vínculo operacional.

https://supabase-automatizaipro.newteksoft.com.br
POST/functions/v1/erp-whatsapp-bridge
AÇÃOdelete-instanceBearer AuthKey
Ver exemplo de código
Atenção: esta operação altera dados.

Confirme a instância ou o agendamento antes de executar. Evite repetir a operação sem conferir o resultado anterior.

Cabeçalhos obrigatóriosAuthKey + JSON
AuthorizationBearer SUA_AUTHKEY
Content-Typeapplication/json
Guia de autenticação

Corpo da requisiçãoJSON

Envie os campos abaixo junto com a ação da operação.

_actionstringObrigatório

Identifica a operação neste endpoint. Use "delete-instance".

instance_idstringOpcional*

UUID da instância retornado pela API. Informe este campo ou appkey; não use o ID do dispositivo no seu banco.

appkeystringOpcional*

Nome da instância retornado em instance_name. Alternativa ao instance_id.

* Condições e alternativas estão descritas em cada campo. Quando necessário, selecione a instância por instance_id ou appkey. Um array de destinos pode substituir phone nos envios.

Comportamento e cuidados

  • Informe instance_id ou appkey. Nos exemplos sempre selecionamos explicitamente uma instância da empresa autenticada.
  • Operação destrutiva. Só remova o dispositivo local depois de confirmar deleted=true. A limpeza pode retornar already_absent quando a sessão já não existir.
  • Não use esta operação para apenas encerrar uma sessão; nesse caso use disconnect.

Tratamento de falhas

Confira o HTTP e os campos da resposta. Em falhas, preserve code e request_id para diagnóstico. HTTP 200 e success=true nem sempre significam envio completo ou exclusão confirmada.

Códigos de erro e próximos passos