Remove advertiser share

Revokes a user's share on an advertiser, as the Shares grid of the console does.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/advertiserShares/{userId}/{advertiserId}.do

Revokes a user's share on an advertiser, as the Shares grid of the console does. The response echoes the userId and advertiserId. Works for a deleted advertiser too, so a share left on one can be cleaned up. Needs the SHARE permission on campaigns at ALL level; at SHARED level the caller's own share on the advertiser must be higher than the one being removed, or the user must be one the caller owns.

Path Params

userId integer required

ID of the user whose share is removed

5001

advertiserId integer required

ID of the advertiser the share is on

1001

Responses

200

Share removed: {success, userId, advertiserId}

400

Bad request — invalid or missing parameters

401

Authentication error

403

Not allowed to remove this share

404

No such user or advertiser, or the user has no share on it

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/advertiserShares/5001/1001.do' \
  --header 'X-Api-Key: YOUR_API_KEY'

Python Request

import requests

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

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/advertiserShares/5001/1001.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/advertiserShares/5001/1001.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/advertiserShares/5001/1001.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/advertiserShares/5001/1001.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/advertiserShares/5001/1001.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/advertiserShares/5001/1001.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