Overview
The Deals API is used to create, retrieve, and modify deals. A deal is an agreement to purchase inventory between a buyer and a seller.
There are three types of deal sources:
- Manual deals are created with the Buyer Cloud API to track deals that were negotiated offline between a seller and buyer.
- Curated deals are pre-negotiated deals between Buyer Cloud and publishers that are automatically available for targeting.
- Synced deals are created by publishers using FreeWheel Publisher Suite. These deals are automatically synced from FreeWheel to Buyer Cloud using your seat ID.
To serve on a specific deal, use a line item to target the deal.
Use the Deals API to accomplish the following tasks:
- Retrieve all deals
- Retrieve all curated deals
- Create a deal
- Retrieve, update, partially update, or delete a deal using its ID
- Retrieve, update, or partially update a curated deal using its ID
- Bulk create, update, and delete multiple deals at once
Uniform Resource Identifiers (URI)
| Feature | URI |
|---|---|
| /deals | https://{buzz_key}.api.beeswax.com/rest/v2/deals |
| /curated-deals | https://{buzz_key}.api.beeswax.com/rest/v2/curated-deals |
