Skip to main content
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
mobile
/
request-unbanning
Request unbanning
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>"
}

​
Overview

Method used to request the unbanning of a number.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Body

​
appealToken
string
required
Appeal token for unbanning the number
​
description
string
required
Reason for the unbanning request, which will be reviewed by WhatsApp

​
Request Body

{
  "appealToken": "Ae1CIGl4Mq7kQ09OQzUnnCx2mTPHxZCjPesdRc8Z1lNFV9d6gvtd5LDW0r7ukVAgtMOP2AxckQM6QeyVp7bL0RbbVac6GQUtMd4tYAZsPOwSIQKlVIoTZs2akgcRd-jvhLKh32roOd0KFPg7hAaYURpIuDXhkaZ_gLJLhmzADNp3lxUNdsIg10q92w",
  "description": "I was chatting normally and got banned"
}

​
Response

​
200

​
success
boolean
Returns true if the request was successful
​
status
string
Request status: IN_REVIEW (under review) or UNBANNED (unbanned)
{
  "success": true,
  "status": "IN_REVIEW"
}

​
400

Invalid request. Check if the data you are sending matches the documentation.

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.