/

Browse the help center

Delete template

Deletes a creative template by ID.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do

Deletes a creative template by ID. A template that non-deleted banners are built on, or that non-deleted placements use as their native adapter, is refused with 409 listing them under usages, unless force=true: then it is deleted, those banners and placements are detached from it, and detachedBanners / detachedPlacements say how many. Requires DELETE permission on templates.

Form Params

id integer

ID of the template — omit on edit to create a new template; delete and export need it

12

active boolean

Whether the template is active

true

alwaysRedirect boolean

Whether the template always uses redirect mode for click tracking

false

content string

Template HTML/JS content body

<div>{{BANNER}}</div>

global boolean

Whether this is a global (system-wide) template

false

impressionRecordedByTemplate boolean

Whether impression tracking is handled by the template itself

false

maxRequiredNativeAdsAmount integer

Maximum number of native ads supported by this template

1

minRequiredNativeAdsAmount integer

Minimum number of native ads required by this template

1

placementType string

Placement type this template applies to

SITE_PLACEMENT

title string

Template title

Standard Banner 300x250

type string

Template type

GENERAL

force boolean

true to delete the template although non-deleted banners or placements still use it; they are detached from it — banners built on it lose their markup, placements lose their native-adapter rendering. Without it such a template is refused with 409 and the users are listed

false

Responses

200

Template deleted successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Insufficient permissions

409

Non-deleted banners or placements still use the template and force was not set; usages lists them

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'id=12'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"id": "12"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"id":"12"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("id=12"))
    .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/template/delete.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["id"] = "12" });

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

Go Request

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do", strings.NewReader(`id=12`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	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/template/delete.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'id=12');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/template/delete.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('id' => "12")

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