Restore a deleted entity

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/{type}/{id}/restore.do

Undoes the newest delete of an advertiser, campaign, banner, site, zone or placement made in the last 90 days: it is no longer deleted, an advertiser, campaign or banner is switched on or off as it was before, its rule groups come back, and so do its banner-placement links - to placements and banners that still exist, are not deleted, still fit and the caller may still see and link (the others are listed in skippedLinks with reason deleted, missing, unsuitable or forbidden). Everything the delete cascaded to (the campaigns and banners of an advertiser, the zones and placements of a site) is restored the same way; a banner whose creative files are no longer in storage stays deleted and is listed in notRestored. Entities deleted on their own before or after the delete are not touched. Takes the same permission as deleting the entity. The ad server serves it again after its next scheduled reload. Answers {success, type, id, name, restored:[{type, id, name}], notRestored, linksRestored, skippedLinks, ruleGroupsRestored, ruleGroupsSkipped, partial}. A refusal changes nothing.

Path Params

type string required

ADVERTISER, CAMPAIGN, BANNER, SITE, ZONE or PLACEMENT (any case)

BANNER

id integer required

The deleted entity's id

3001

Responses

200

Restored

400

Unknown type

401

Authentication error

403

The caller may view the entity but not delete it

404

No such entity, or one the caller may not view

409

Not restorable: {success:false, message, reason, blockedBy?}. reason is NOT_DELETED, NOT_RECORDED (deleted before deletions were recorded, more than 90 days ago, or already restored), PARENT_DELETED (blockedBy {type, id, name} names the deleted advertiser, campaign, site or zone to restore first) or FILES_MISSING (a banner whose creative files are gone)

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/BANNER/3001/restore.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/BANNER/3001/restore.do", headers={"X-Api-Key": "YOUR_API_KEY"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/BANNER/3001/restore.do', {
  method: 'POST',
  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/deleted-entities/BANNER/3001/restore.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .method("POST", 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("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/BANNER/3001/restore.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("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/deleted-entities/BANNER/3001/restore.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/deleted-entities/BANNER/3001/restore.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
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/deleted-entities/BANNER/3001/restore.do")
request = Net::HTTP::Post.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