/

Browse the help center

Create a new action

Creates a new conversion action owned by the authenticated user.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/action/create.do

Creates a new conversion action owned by the authenticated user. Conversion actions represent advertiser-defined events (e.g., purchase, sign-up, app install) that are tracked after ad interactions. All parameters are optional -- omitted fields use system defaults. If 'campaignId' is provided, the response includes the campaign's pixelKey (derived from advertiser ID + campaign ID + action ID); otherwise pixelKey is omitted. The newly created action is returned in the response JSON and logged to the action log. Requires authentication.

Form Params

name string required

Display name for the new action (e.g., 'Purchase', 'Sign Up', 'App Install'), up to 64 characters.

Purchase

clickToConversionTimeFrame integer

Click-to-conversion attribution window duration, 0 to 255 units. For example, 7 with DAY means conversions within 7 days of a click are attributed.

7

clickToConversionTimeFramePeriodType string

Time unit for clickToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR.

DAY

viewToConversionTimeFrame integer

View-to-conversion attribution window duration, 0 to 255 units. For example, 1 with DAY means conversions within 1 day of an impression are attributed.

1

viewToConversionTimeFramePeriodType string

Time unit for viewToConversionTimeFrame. Allowed values: SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, YEAR.

DAY

applyAttributionWindowToServerToServer boolean

Whether the attribution window is also applied to server-to-server conversions. Server-to-server postbacks carry no impression or click identity of their own, so this is off for actions created before the option existed and on for new ones. Omit to keep the current value.

true

rejectDuplicateConversions boolean

Whether a repeat of the same event on one click is thrown away. Off by default: repeats count. Applies to both server-to-server postbacks and the cookie pixel. A tracking-event action repeats by definition and is exempt regardless.

false

defaultAttributionType string

Attribution type applied to a conversion that arrives with no attribution of its own — the last resort, below the action's tracking event, the partner's att= parameter and the classification carried by the tracking token. Allowed values: UNSPECIFIED, POST_CLICK, POST_VIEW (or integer IDs 0, 1, 2). Omit to keep the current value.

POST_CLICK

campaignId integer

Optional campaign ID. When provided, the response includes the computed pixelKey for this campaign context.

2001

Responses

200

Newly created action object with id, key, name, conversion time frames, and optionally a campaign-specific pixelKey

400

Bad request — wrong parameter types

401

Authentication error

403

Not enough permissions

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/action/create.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'name=Purchase' \
  --data-urlencode 'campaignId=2001' \
  --data-urlencode 'clickToConversionTimeFrame=7' \
  --data-urlencode 'clickToConversionTimeFramePeriodType=DAY' \
  --data-urlencode 'viewToConversionTimeFrame=1'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/action/create.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"name": "Purchase", "campaignId": "2001", "clickToConversionTimeFrame": "7", "clickToConversionTimeFramePeriodType": "DAY", "viewToConversionTimeFrame": "1"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/action/create.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"name":"Purchase","campaignId":"2001","clickToConversionTimeFrame":"7","clickToConversionTimeFramePeriodType":"DAY","viewToConversionTimeFrame":"1"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/action/create.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("name=Purchase&campaignId=2001&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY&viewToConversionTimeFrame=1"))
    .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/action/create.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["name"] = "Purchase", ["campaignId"] = "2001", ["clickToConversionTimeFrame"] = "7", ["clickToConversionTimeFramePeriodType"] = "DAY", ["viewToConversionTimeFrame"] = "1" });

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/action/create.do", strings.NewReader(`name=Purchase&campaignId=2001&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY&viewToConversionTimeFrame=1`))
	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/action/create.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, 'name=Purchase&campaignId=2001&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY&viewToConversionTimeFrame=1');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/action/create.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('name' => "Purchase", 'campaignId' => "2001", 'clickToConversionTimeFrame' => "7", 'clickToConversionTimeFramePeriodType' => "DAY", 'viewToConversionTimeFrame' => "1")

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