Create a PMP deal for campaign

Creates a new Private Marketplace deal for the specified campaign, establishing a private auction agreement with a buyer at a negotiated price floor.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/campaign/{campaignId}/pmp-deal.do

Creates a new Private Marketplace deal for the specified campaign, establishing a private auction agreement with a buyer at a negotiated price floor. The deal is associated with the campaign and will be included in OpenRTB bid requests sent to the specified buyer. The response JSON contains the newly created deal record with its assigned internal ID. Requires standard REST API authentication.

Path Params

campaignId integer required

Numeric ID of the campaign to associate the new PMP deal with

2001

Form Params

dealId string required

External PMP deal identifier string used in OpenRTB bid requests between buyer and seller

deal-123

buyerId string required

Buyer seat identifier string that identifies the DSP or buyer in the OpenRTB protocol

buyer-456

auctionType string required

Auction pricing model for this deal. FIRST_PRICE: winner pays their bid; SECOND_PRICE: winner pays second-highest bid plus increment; BID_FLOOR: fixed minimum price

FIRST_PRICE

country string required

ISO 3166-1 alpha-2 country code (e.g. 'US', 'DE') to restrict the deal to a specific country, or '*' to make it a global deal with no country restriction

US

bidFloor number required

Minimum bid price (floor) for this deal in the campaign's currency. Bids below this value are rejected.

2.50

Responses

200

PMP deal created successfully

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

404

Not found — resource does not exist

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pmp-deal.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'dealId=deal-123' \
  --data-urlencode 'buyerId=buyer-456' \
  --data-urlencode 'auctionType=FIRST_PRICE' \
  --data-urlencode 'country=US' \
  --data-urlencode 'bidFloor=2.50'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pmp-deal.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"dealId": "deal-123", "buyerId": "buyer-456", "auctionType": "FIRST_PRICE", "country": "US", "bidFloor": "2.50"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pmp-deal.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"dealId":"deal-123","buyerId":"buyer-456","auctionType":"FIRST_PRICE","country":"US","bidFloor":"2.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/campaign/2001/pmp-deal.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("dealId=deal-123&buyerId=buyer-456&auctionType=FIRST_PRICE&country=US&bidFloor=2.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/campaign/2001/pmp-deal.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["dealId"] = "deal-123", ["buyerId"] = "buyer-456", ["auctionType"] = "FIRST_PRICE", ["country"] = "US", ["bidFloor"] = "2.50" });

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/campaign/2001/pmp-deal.do", strings.NewReader(`dealId=deal-123&buyerId=buyer-456&auctionType=FIRST_PRICE&country=US&bidFloor=2.50`))
	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/campaign/2001/pmp-deal.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, 'dealId=deal-123&buyerId=buyer-456&auctionType=FIRST_PRICE&country=US&bidFloor=2.50');

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

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/campaign/2001/pmp-deal.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('dealId' => "deal-123", 'buyerId' => "buyer-456", 'auctionType' => "FIRST_PRICE", 'country' => "US", 'bidFloor' => "2.50")

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