Pular para o conteúdo principal

Bloquear contato

Método#

/contacts/modify-blocked#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/contacts/modify-blocked

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Conceituação#

Este método é reponsavel por bloquear ou desbloquear um contato.


Atributos#

Obrigatórios#

AtributosTipoDescrição
phoneintegerNúmero de telefone que você deseja alterar no SEU chat
actionstringAtributo para bloquear ou desbloquear o contato (block ou unblock)

Request Body#

Exemplo

{
"phone": "5544999999999",
"action": "block" ou "unblock"
}

Response#

200#

AtributosTipoDescrição
valuebooleanAtributo de confirmação da ação

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 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#