Delete cappings by IDs

Permanently deletes one or more capping objects, identified by pairs of capping ID and capping type.

Reference

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

Permanently deletes one or more capping objects, identified by pairs of capping ID and capping type. Each element in the ids array must be a colon-separated string in the format 'capping_id:capping_type' (e.g. '123:CAMPAIGN_FREQUENCY', '456:PLACEMENT_CLICKS'). The capping type is required because capping IDs are only unique within one capping type. Requires UPDATE permission on the entity each capping belongs to, and MANAGE_INVENTORY_CAPPING (placement cappings) or MANAGE_CAPPING_AND_LIMITATIONS (the others) enabled; when one id is refused, nothing is deleted.

Form Params

ids array<string> required

Array of colon-separated 'capping_id:capping_type' pairs to delete (e.g. '123:CAMPAIGN_FREQUENCY', '456:PLACEMENT_CLICKS')

123:CAMPAIGN_FREQUENCY

Responses

200

Cappings deleted successfully

400

An id is not in the id:TYPE format, or names an unknown capping type; the message says which

401

Authentication error

403

The caller may not change the entity one of the cappings belongs to

404

One of the ids is not a capping of the given type

Language

cURL Request

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

Python Request

import requests

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

Node Request

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

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

Java Request

HttpClient client = HttpClient.newHttpClient();

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

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/capping/delete.do", strings.NewReader(`ids=123%3ACAMPAIGN_FREQUENCY`))
	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/capping/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, 'ids=123%3ACAMPAIGN_FREQUENCY');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/capping/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('ids' => "123:CAMPAIGN_FREQUENCY")

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