Pular para o conteúdo principal

Deletar canal

Método#

/delete-newsletter#

DELETE https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/delete-newsletter

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é responsável por deletar um canal.


Atributos#

Obrigatórios#

AtributosTipoDescrição
idstringID do canal

Request Body#

URL#

Método

DELETE https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/delete-newsletter

Body#

{
"id": "999999999999999999@newsletter"
}
warning

O id do canal sempre deve conter o sufixo "@newsletter", pois esse é o padrão utilizado pelo próprio WhatsApp.


Response#

200#

AtributosTipoDescrição
valuebooleantrue caso tenha dado certo e false em caso de falha

Exemplo

{
"value": true
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST, DELETE ou GET conforme especificado no inicio 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"


Code#