PMP Deals API endpoints
Endpoint reference for the PMP Deals tag (6 endpoints): Private Marketplace deal management
Private Marketplace deal management. 6 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.
POST /rest-api/campaign/{campaignId}/pmp-deal.do
Create a PMP deal for campaign.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Numeric ID of the campaign to associate the new PMP deal with |
dealId | form | string | yes | External PMP deal identifier string used in OpenRTB bid requests between buyer and seller |
buyerId | form | string | yes | Buyer seat identifier string that identifies the DSP or buyer in the OpenRTB protocol |
auctionType | form | string | yes | 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 Values: FIRST_PRICE, SECOND_PRICE, BID_FLOOR. |
country | form | string | yes | 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 |
bidFloor | form | number | yes | Minimum bid price (floor) for this deal in the campaign’s currency. Bids below this value are rejected. |
Responses: 200 — PMP deal created successfully · 404 — Not found — resource does not exist. Errors follow the shared conventions.
GET /rest-api/campaign/{campaignId}/pmp-deals.do
List PMP deals for campaign.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Numeric ID of the campaign whose PMP deals should be retrieved |
Responses: 200 — PMP deals retrieved successfully · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/pmp-deals/disable.do
Disable PMP deals for campaign.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Numeric ID of the campaign |
Responses: 200 — PMP deals disabled; pmpDealsEnabled echoes the new state · 404 — Campaign not found or deleted. Errors follow the shared conventions.
POST /rest-api/campaign/{campaignId}/pmp-deals/enable.do
Enable PMP deals for campaign.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer | yes | Numeric ID of the campaign |
Responses: 200 — PMP deals enabled; pmpDealsEnabled echoes the new state · 404 — Campaign not found or deleted. Errors follow the shared conventions.
POST /rest-api/campaign/pmp-deal/{id}.do
Update a PMP deal.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | yes | Internal numeric ID of the PMP deal record to update (obtained from the list PMP deals response) |
dealId | form | string | yes | External PMP deal identifier string used in OpenRTB bid requests between buyer and seller |
buyerId | form | string | yes | Buyer seat identifier string that identifies the DSP or buyer in the OpenRTB protocol |
auctionType | form | string | yes | 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 Values: FIRST_PRICE, SECOND_PRICE, BID_FLOOR. |
country | form | string | yes | 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 |
bidFloor | form | number | yes | Minimum bid price (floor) for this deal in the campaign’s currency. Bids below this value are rejected. |
Responses: 200 — PMP deal updated successfully · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/campaign/pmp-deals/delete.do
Delete PMP deals.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ids | form | array<integer> | yes | One or more internal numeric IDs of the PMP deal records to permanently delete |
Responses: 200 — PMP deals deleted successfully. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
- Network services and miscellaneous APIs
