Replace a stale location

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.do

Swaps one stale location rule for a rule naming a place the geo database knows, with the same include or exclude and the same entity, and removes the stale rule; both changes are written to the action log. Region and city are optional and checked like location targeting create. When the entity already has that rule, only the stale one is removed and 'alreadyPresent' is true. Country rules cannot be replaced; remove them instead.

Form Params

targetId integer required

Id of the stale location rule

8012

countryCode string required

ISO 3166-1 alpha-2 country code of the new place

US

regionName string

Region of the new place, as GET /rest-api/targeting/country/region/values.do lists it

Nevada

cityName string

City of the new place, as GET /rest-api/targeting/country/region/city/values.do lists it

Las Vegas

Responses

200

{success, removedId, targetId, value, alreadyPresent}

400

Unknown country code, region or city, or the rule is a country rule

401

Authentication error

403

The role may not change this rule

404

Not a stale rule the user may manage

503

The geo service did not answer

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'targetId=8012' \
  --data-urlencode 'countryCode=US' \
  --data-urlencode 'regionName=Nevada' \
  --data-urlencode 'cityName=Las Vegas'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"targetId": "8012", "countryCode": "US", "regionName": "Nevada", "cityName": "Las Vegas"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"targetId":"8012","countryCode":"US","regionName":"Nevada","cityName":"Las Vegas"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("targetId=8012&countryCode=US&regionName=Nevada&cityName=Las%20Vegas"))
    .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/targeting/stale-locations/replace.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["targetId"] = "8012", ["countryCode"] = "US", ["regionName"] = "Nevada", ["cityName"] = "Las Vegas" });

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/targeting/stale-locations/replace.do", strings.NewReader(`targetId=8012&countryCode=US&regionName=Nevada&cityName=Las%20Vegas`))
	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/targeting/stale-locations/replace.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, 'targetId=8012&countryCode=US&regionName=Nevada&cityName=Las%20Vegas');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/targeting/stale-locations/replace.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('targetId' => "8012", 'countryCode' => "US", 'regionName' => "Nevada", 'cityName' => "Las Vegas")

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