Delete a catalogue

This endpoint deletes a catalogue. When a catalog is deleted, all of its audiences are also deleted

DELETE /catalogues/{catalogue_id}

Delete a catalogue

cURL

curl --request DELETE \
  --url http://localhost:3001/portal-api/catalogues/{catalogue_id} \
  --header 'Authorization: <api-key>'

import requests

url = "http://localhost:3001/portal-api/catalogues/{catalogue_id}"

headers = {"Authorization": "<api-key>"}

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

print(response.text)

const options = {method: 'DELETE', headers: {Authorization: '<api-key>'}};

fetch('http://localhost:3001/portal-api/catalogues/{catalogue_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/portal-api/catalogues/{catalogue_id}",
  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: <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 := "http://localhost:3001/portal-api/catalogues/{catalogue_id}"

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

	req.Header.Add("Authorization", "<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("http://localhost:3001/portal-api/catalogues/{catalogue_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3001/portal-api/catalogues/{catalogue_id}")

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

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

response = http.request(request)
puts response.read_body

200

{
  "status": "ok"
}

{
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

catalogue_id · integer · required

UID of a catalogue

Example:

1

Response

200

application/json

OK

status · string

Status of the operation

Example:

"ok"