/

Browse the help center

Email a site's invocation codes

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/sites/{siteId}/invocation-codes/send.do

Emails the chosen invocation codes of the site's placements to up to 20 recipients, through the network's invocation-code email template, whose subject and body the request's subject and body replace when sent. A network without that template can still mail them when the request sends both subject and body. The message is always sent from the caller's own address. Code types the caller may not generate for a placement are rejected, and every placement must be a live placement of the site in the path. Requires VIEW access to the site's inventory (ALL, or SHARED with a share on the site).

Path Params

siteId integer required

Site ID

5001

Form Params

bccAuthor boolean

Send a blind copy to the caller's own address

false

body string

Email HTML body; the invocation-code email template's body when omitted. Required, with subject, when the network has no such template

<p>Tags for your site are attached.</p>

emails array<string>

Recipient addresses, at most 20

publisher@example.com

placementInvocationCodes object

Code types to send per placement ID. Every placement must belong to the site in the path.

{"4001": "AJAX"}

singleFile boolean

Attach every code in one text file (true) or one file per placement and code type (false)

true

subject string

Email subject; the invocation-code email template's subject when omitted. Required, with body, when the network has no such template

Your ad tags

Responses

200

{success, recipients} — the codes were handed to the mailer

400

Invalid recipients, no placements, a placement of another site, a code type unavailable for the placement, or no invocation-code email template configured and no subject and body sent

401

Authentication error

403

No VIEW access to the site

404

Site or placement not found or deleted

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes/send.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'bccAuthor=false' \
  --data-urlencode 'body=<p>Tags for your site are attached.</p>' \
  --data-urlencode 'emails=publisher@example.com'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes/send.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"bccAuthor": "false", "body": "<p>Tags for your site are attached.</p>", "emails": "publisher@example.com"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes/send.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"bccAuthor":"false","body":"<p>Tags for your site are attached.</p>","emails":"publisher@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/sites/5001/invocation-codes/send.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("bccAuthor=false&body=%3Cp%3ETags%20for%20your%20site%20are%20attached.%3C%2Fp%3E&emails=publisher%40example.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/sites/5001/invocation-codes/send.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["bccAuthor"] = "false", ["body"] = "<p>Tags for your site are attached.</p>", ["emails"] = "publisher@example.com" });

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/invocation-codes/send.do", strings.NewReader(`bccAuthor=false&body=%3Cp%3ETags%20for%20your%20site%20are%20attached.%3C%2Fp%3E&emails=publisher%40example.com`))
	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/invocation-codes/send.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, 'bccAuthor=false&body=%3Cp%3ETags%20for%20your%20site%20are%20attached.%3C%2Fp%3E&emails=publisher%40example.com');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/sites/5001/invocation-codes/send.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('bccAuthor' => "false", 'body' => "<p>Tags for your site are attached.</p>", 'emails' => "publisher@example.com")

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