/

Browse the help center

Update a placement piggyback

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/{id}/update.do

Changes one placement piggyback the way the console's piggyback grid does: codeUrl, active, sampling, deliveryAttribution and the action it fires for (actionId, or allActions=true for every action of the campaign). A field not sent keeps its value; the type cannot change. Needs the Piggyback Pixel Tracking permission and update rights on the placement's site. Returns the piggyback as the list does, in 'piggyback'. Parameters that were sent but not applied are listed in 'ignoredFields', each with its reason in 'ignoredFieldReasons'.

Path Params

id integer required

The unique numeric identifier of the piggyback to change

701

Form Params

actionId integer

Fire only for this action; ignored when allActions is true

101

active boolean

Whether the piggyback fires

true

allActions boolean

true to fire for every action of the campaign

false

codeUrl string

New tracking code (BEACON) or URL (URL type)

https://tracker.example.com/pixel?pid=789

deliveryAttribution string

Which conversions the piggyback fires for: ALL, POST_CLICK_ONLY or POST_VIEW_ONLY

ALL

sampling integer

Percentage of conversions the piggyback fires on (0-100)

100

Responses

200

Piggyback updated (success:true), or success:false with per-field 'errors'

400

Bad request — invalid or missing parameters

401

Unauthorized - authentication error

403

Forbidden - no update rights on the placement, or the Piggyback Pixel Tracking permission is not enabled

404

No placement piggyback with this id

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/701/update.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'active=true' \
  --data-urlencode 'actionId=101' \
  --data-urlencode 'allActions=false'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/701/update.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"active": "true", "actionId": "101", "allActions": "false"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/701/update.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"active":"true","actionId":"101","allActions":"false"}),
});

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

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/701/update.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("active=true&actionId=101&allActions=false"))
    .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/piggyback/placement/701/update.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["active"] = "true", ["actionId"] = "101", ["allActions"] = "false" });

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/piggyback/placement/701/update.do", strings.NewReader(`active=true&actionId=101&allActions=false`))
	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/piggyback/placement/701/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, 'active=true&actionId=101&allActions=false');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/placement/701/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('active' => "true", 'actionId' => "101", 'allActions' => "false")

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