Deal.id

The deal identifier agreed between buyer and seller before any request is sent. Required. A bid made under the deal returns it in Bid.dealid.

CurrentstringRequiredSince 2.3

Field facts

Path
imp.pmp.deals.id
Object
Deal
Type
string
Requirement
Required
Added
OpenRTB 2.3
Spec section
3.2.12

How it is used

Buyers attach the id to the line items or campaigns that should run on the deal, not to a whole seat or advertiser, so it acts as a targeting key. If the ids do not match exactly on both sides, the deal never triggers and the impression gets open-market treatment with no error anywhere.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "imp": [
    {
      "pmp": {
        "deals": [
          {
            "id": "DEAL-2026-0142"
          }
        ]
      }
    }
  ]
}

Common mistakes

  • Changing case or adding whitespace between deal setup and the request, so the buyer's lookup misses.
  • Reusing one id for deals with different terms.

Version history

Added in OpenRTB 2.3, and present in the latest snapshot. The table shows how each version's spec text types the field.

VersionsType in the specRequiredDeprecated
2.3 to 2.3.1stringYesNo
2.4stringYesNo
2.5 to 2.6-202606stringYesNo

Related fields

Other Deal fields

For a walkthrough of the whole object, read Deals and PMP.