Deletando uma instância
curl --request DELETE \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete \
--header 'Authorization: <authorization>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete"
headers = {"Authorization": "<authorization>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<authorization>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_bodyPartners
Deletando uma instância
Deleta uma instância vinculada à sua conta de parceiro integrador
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
integrator
/
on-demand
/
delete
Deletando uma instância
curl --request DELETE \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete \
--header 'Authorization: <authorization>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete"
headers = {"Authorization": "<authorization>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: '<authorization>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_bodyConceituação
Método utilizado para deletar uma instância vinculada à sua conta. Para deletar várias de uma vez, use Deletando instâncias em lote.Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato:
Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.A exclusão é definitiva e não pode ser desfeita.
Regras de elegibilidade
Uma instância só é deletada quando atende a todas as condições abaixo:- Está desconectada do WhatsApp e do celular.
- Está com status de pagamento pendente, trial ou cancelado. Instâncias pagas, com boleto pendente, em processo de cancelamento, em retentativa de pagamento ou sem status de pagamento definido não são elegíveis.
- Se estiver pendente, não tem assinatura pendente. Cancele a assinatura antes de deletar a instância.
Atributos
Header
string
obrigatório
Token de parceiro no formato
Bearer <Partner-Token>Path
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
string
obrigatório
Token da sua instância Z-API.
Response
204
A instância foi deletada. A resposta não tem corpo.403
A instância não atende às regras de elegibilidade. O campotype identifica a regra que bloqueou a exclusão e o campo message descreve o motivo.
{
"type": "INSTANCE_HAS_ACTIVE_SUBSCRIPTION",
"message": "Cannot delete instance because it has a pending subscription. Cancel the subscription first"
}
| type | message | Quando acontece |
|---|---|---|
INSTANCE_STILL_CONNECTED | Cannot delete instance because it is still connected to WhatsApp or phone | A instância ainda está conectada ao WhatsApp ou ao celular. Desconecte antes de deletar. |
INSTANCE_PAYMENT_STATUS_MISSING | Cannot delete instance because payment status is unknown | A instância não tem status de pagamento definido. |
INSTANCE_NOT_ELIGIBLE | Cannot delete instance because it is still active | O status de pagamento não é pendente, trial nem cancelado (por exemplo: paga, boleto pendente, em processo de cancelamento ou em retentativa de pagamento). |
INSTANCE_HAS_ACTIVE_SUBSCRIPTION | Cannot delete instance because it has a pending subscription. Cancel the subscription first | A instância está pendente e tem assinatura pendente. Cancele a assinatura antes de deletar. |
401
O header Authorization não foi enviado ou o Token de Parceiro é inválido.{
"message": "Authorization token is empty"
}
404
Não existe instância para o parinstanceId e token informado.
{
"message": "Instance not found"
}