Delete banner

Soft-deletes the specified banner, marking it as deleted without physically removing the database record.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/banner/{bannerId}/delete.do

Soft-deletes the specified banner, marking it as deleted without physically removing the database record. The banner must exist and not already be deleted. Requires DELETE permission on the banner's advertiser. Returns 404 if the banner is not found or already deleted. For 90 days POST /rest-api/deleted-entities/BANNER/{id}/restore.do brings it back, links included.

Path Params

bannerId integer required

ID of the banner to delete

3001

Responses

200

Banner deleted

400

Invalid request or banner not found

401

Authentication error

403

Not enough permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("DELETE", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do", nil)
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY"]);

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/banner/3001/delete.do")
request = Net::HTTP::Delete.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body