Update campaign piggyback

Updates one or more existing piggyback tracking pixels for the specified campaign in a single batch request.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/campaign/update.do

Updates one or more existing piggyback tracking pixels for the specified campaign in a single batch request. Each element in the request body array is a map containing the piggyback fields to update (e.g., code/URL, type, status, sampling). The caller must have update permissions on the campaign and the Piggyback Pixel Tracking permission. Returns a JSON object with a 'success' boolean indicating whether all updates succeeded.

Query Params

campaignId integer required

The unique numeric identifier of the campaign whose piggyback pixels should be updated

2001

Body

A JSON body. An example, built from the field definitions:

[
  {}
]

Responses

200

Campaign piggyback updated successfully

400

An invalid field (per-field errors); nothing is saved

401

Unauthorized - authentication error

403

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

404

Campaign, site or placement not found or deleted

500

Internal server error

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/campaign/update.do?campaignId=2001' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": 501,
    "active": true,
    "sampling": 50
  }
]'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/campaign/update.do?campaignId=2001", headers={"X-Api-Key": "YOUR_API_KEY"}, json=[
    {
        "id": 501,
        "active": True,
        "sampling": 50
    }
])
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/campaign/update.do?campaignId=2001', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/json' },
  body: JSON.stringify([
    {
      "id": 501,
      "active": true,
      "sampling": 50
    }
  ]),
});

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/campaign/update.do?campaignId=2001"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("[{\"id\":501,\"active\":true,\"sampling\":50}]"))
    .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/campaign/update.do?campaignId=2001");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new StringContent("[{\"id\":501,\"active\":true,\"sampling\":50}]", Encoding.UTF8, "application/json");

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/campaign/update.do?campaignId=2001", strings.NewReader(`[{"id":501,"active":true,"sampling":50}]`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/json")

	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/campaign/update.do?campaignId=2001");
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/json"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '[{"id":501,"active":true,"sampling":50}]');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/piggyback/campaign/update.do?campaignId=2001")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/json'
request.body = "[{\"id\":501,\"active\":true,\"sampling\":50}]"

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