Update a header-bidding tag

Changes only the fields in the body and keeps every other one as it is — {"refreshInViewOnly": true} touches nothing else.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/{tagId}.do

Changes only the fields in the body and keeps every other one as it is — {"refreshInViewOnly": true} touches nothing else. slots, when sent, replace all slots: repeat a slot's id (and its bidders' ids) to keep it, leave a slot out to remove it. The site cannot change. The response is the stored tag and its page code; fields that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'. Requires the HEADER_BIDDING_TAB_VISIBLE permission and access to the tag's site. UPDATE access to the site is needed.

Path Params

tagId integer required

Unique numeric ID of the tag

1

Body

A JSON body. An example, built from the field definitions:

{
  "id": "1",
  "siteId": "139",
  "name": "Futbol24 — desktop",
  "domain": "ads.example.com"
}

Responses

200

{data: tag, code, ignoredFields, ignoredFieldReasons}

400

Refused, the reason in msg or per field in errors

401

Authentication error

403

Insufficient permissions, naming the missing one

404

Tag not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "1",
  "siteId": "139",
  "name": "Futbol24 — desktop",
  "domain": "ads.example.com"
}'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do", headers={"X-Api-Key": "YOUR_API_KEY"}, json={
    "id": "1",
    "siteId": "139",
    "name": "Futbol24 — desktop",
    "domain": "ads.example.com"
})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "id": "1",
    "siteId": "139",
    "name": "Futbol24 — desktop",
    "domain": "ads.example.com"
  }),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"id\":\"1\",\"siteId\":\"139\",\"name\":\"Futbol24 — desktop\",\"domain\":\"ads.example.com\"}"))
    .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/hb-tags/1.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("{\"id\":\"1\",\"siteId\":\"139\",\"name\":\"Futbol24 — desktop\",\"domain\":\"ads.example.com\"}", Encoding.UTF8, "application/json");

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/hb-tags/1.do", strings.NewReader(`{"id":"1","siteId":"139","name":"Futbol24 — desktop","domain":"ads.example.com"}`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/hb-tags/1.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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"id":"1","siteId":"139","name":"Futbol24 — desktop","domain":"ads.example.com"}');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/hb-tags/1.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "{\"id\":\"1\",\"siteId\":\"139\",\"name\":\"Futbol24 — desktop\",\"domain\":\"ads.example.com\"}"

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