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 a assinatura cancelada. Instâncias pagas, pendentes, com boleto pendente, em processo de cancelamento ou em retentativa de pagamento não são elegíveis.
- Não está em trial. Um trial precisa expirar naturalmente ou ser cancelado antes.
- Já passou da carência de 40 dias contados da data de cancelamento da assinatura.
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.400
A instância não atende às regras de elegibilidade. O campomessage informa o motivo.
{
"message": "Cannot delete instance because it is still in the grace period of 40 days after cancellation"
}
| Mensagem | Quando acontece |
|---|---|
Cannot delete instance because it is still connected to WhatsApp or phone | A instância ainda está conectada. |
Cannot delete a trial instance. Trials must expire naturally or be canceled first | A instância está em trial. |
Cannot delete instance because it is still active | A assinatura ainda está ativa. |
Cannot delete instance because payment status is not canceled | A assinatura não está cancelada. |
Cannot delete instance because it is still in the grace period of 40 days after cancellation | A instância foi cancelada há menos de 40 dias. |
Cannot delete instance because payment status is unknown | Não foi possível determinar o status de pagamento. |
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"
}