Add site ads.txt lines

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/ads-txt/lines.do

Parses 'lines' the IAB ads.txt 1.1 way — blank lines and # comments skipped, variables kept — and appends what it adds to the site's additional ads.txt lines, each line once: lines of a partner that sells the site but is not an advertiser here, such as a header-bidding bidder. OWNERDOMAIN and MANAGERDOMAIN describe the site owner and are set only on the White Label page; CONTACT and SUBDOMAIN belong to the publisher's own file; a line with any of them is refused. When a line is malformed or refused nothing is stored and the answer carries success=false, invalidLines (1-based line numbers) and msg. Returns the site's ads.txt view as the GET does. Requires ENABLED level on the SITE_SUPPLY_CHAIN permission and UPDATE permission on the site; a masked share is refused.

Path Params

siteId integer required

Unique numeric ID of the site

5001

Form Params

lines string required

The block as the partner gave it, one line per line

adform.com, 1234, RESELLER

Responses

200

Lines added, or refused with invalidLines

400

Bad request — invalid or missing parameters

401

Authentication error

403

No SITE_SUPPLY_CHAIN permission, or the site is outside the caller's shares or masked

404

Site not found

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt/lines.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'lines=adform.com, 1234, RESELLER'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt/lines.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"lines": "adform.com, 1234, RESELLER"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt/lines.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"lines":"adform.com, 1234, RESELLER"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt/lines.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("lines=adform.com%2C%201234%2C%20RESELLER"))
    .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/sites/5001/ads-txt/lines.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["lines"] = "adform.com, 1234, RESELLER" });

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/sites/5001/ads-txt/lines.do", strings.NewReader(`lines=adform.com%2C%201234%2C%20RESELLER`))
	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/sites/5001/ads-txt/lines.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, 'lines=adform.com%2C%201234%2C%20RESELLER');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/ads-txt/lines.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('lines' => "adform.com, 1234, RESELLER")

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