Pular para o conteúdo principal
DELETE
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
/
{collectionId}
Deletar coleção
curl --request DELETE \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/{collectionId} \
  --header 'Client-Token: <api-key>'
import requests

url = "https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/{collectionId}"

headers = {"Client-Token": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)
const options = {method: 'DELETE', headers: {'Client-Token': '<api-key>'}};

fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/{collectionId}', 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}/catalogs/collection/{collectionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Client-Token: <api-key>"
  ],
]);

$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}/catalogs/collection/{collectionId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Client-Token", "<api-key>")

	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}/catalogs/collection/{collectionId}")
  .header("Client-Token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection/{collectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Client-Token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "success": true
}

Conceituação

Este método é responsável por deletar uma coleção existente no catálogo do WhatsApp Business.

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.

Path

collectionId
string
obrigatório
ID da coleção a ser deletada

Response

200

success
boolean
true caso tenha dado certo e false em caso de falha
{
  "success": true
}

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”.