/

Browse the help center

Update action by action key

Updates an existing conversion action identified by its unique action key.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/action/{key}/update.do

Updates an existing conversion action identified by its unique action key. Only provided (non-null) request parameters are applied as a partial update -- omitted fields retain their current values. You can update the action name, click-to-conversion time frame/period, and view-to-conversion time frame/period. Returns 404 if no action exists with the given key. The update is logged to the action log. Requires authentication.

Path Params

key string required

The unique action key string identifying the action to update.

a1b2c3d4e5

Form Params

name string

New display name for the action, up to 64 characters and not blank. If omitted, the existing name is preserved.

Purchase

clickToConversionTimeFrame integer

Click-to-conversion attribution window duration, 0 to 255 units. Defines how long after a click a conversion can be attributed to the ad.

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. Defines how long after an ad view/impression a conversion can be 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

Responses

200

The updated action, in the shape the action GET returns

400

Bad request — wrong parameter types

401

Authentication error

403

Not enough permissions

404

No action found with the given action key

Language

cURL Request

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

Python Request

import requests

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

Node Request

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

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/a1b2c3d4e5/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("name=Purchase&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY"))
    .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/a1b2c3d4e5/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["name"] = "Purchase", ["clickToConversionTimeFrame"] = "7", ["clickToConversionTimeFramePeriodType"] = "DAY" });

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/a1b2c3d4e5/update.do", strings.NewReader(`name=Purchase&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY`))
	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/a1b2c3d4e5/update.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&clickToConversionTimeFrame=7&clickToConversionTimeFramePeriodType=DAY');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/action/a1b2c3d4e5/update.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", 'clickToConversionTimeFrame' => "7", 'clickToConversionTimeFramePeriodType' => "DAY")

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