Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
request-unbanning
Solicitar desbanimento
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/mobile/request-unbanning \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "appealToken": "<string>",
  "description": "<string>"
}
'
{
  "success": true,
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para solicitar desbanimento de um número.

​
Atributos

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

​
Body

​
appealToken
string
obrigatório
Token de apelação para desbanimento do número
​
description
string
obrigatório
Motivo da solicitação de desbanimento, que será analisado pelo WhatsApp

​
Request Body

{
  "appealToken": "Ae1CIGl4Mq7kQ09OQzUnnCx2mTPHxZCjPesdRc8Z1lNFV9d6gvtd5LDW0r7ukVAgtMOP2AxckQM6QeyVp7bL0RbbVac6GQUtMd4tYAZsPOwSIQKlVIoTZs2akgcRd-jvhLKh32roOd0KFPg7hAaYURpIuDXhkaZ_gLJLhmzADNp3lxUNdsIg10q92w",
  "description": "Estava conversando normalmente e fui banido"
}

​
Response

​
200

​
success
boolean
Retorna true caso a solicitação tenha ocorrido com sucesso
​
status
string
Status da solicitação: IN_REVIEW (em análise) ou UNBANNED (desbanido)
{
  "success": true,
  "status": "IN_REVIEW"
}

​
400

Requisição inválida. Verifique se os dados que você está enviando estão de acordo com o documentado.

​
405

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