Demand partners

The partner slugs accepted in a buyer's partner field, the DV360 field rules, and which deals let you set their status.

Set each buyer's partner to one of the slugs below. Direct DSPs use their
own slug. BidSwitch is reached as a whole on an open deal, with
bidswitch, and through one of its sub-DSPs on a pmp deal, with a
bsw--prefixed slug; for those, put the raw DSP seat ID in seatIds (do not
include a :). If you work with a partner that isn't listed, ask your Sovrn
representative.

SSPs that Sovrn resells to are not buyers, and are not listed here. A request
that names one returns 400 listing the slugs it accepts. A deal that already
has one still reads with it, and an edit that sends no buyers still saves.

Direct partners

SlugPartner
simpli.fiSimpli.fi
basisBasis (Centro)
dv360DV360 (DBM)
thetradedeskTradeDesk
quantcastQuantcast
pulsepointPulsePoint
illuminIllumin (AcuityAds)
clickagyClickagy
beeswaxBeeswax
rtbhouseRTB House
mediaforceMedia Force
xandrXandr
nexxenNexxen (Unruly)
epomEpom
madhiveMadhive
krushKrush Media
operaOpera
motorikMotorik
emodoEmodo
edge226Edge226
decenteradsDecenterAds
consumableConsumable
epsilonEpsilon
boldwinBoldwin
taurusxTaurusX
stiristaStirista
140proof140Proof
altavaraAltavara
adipoloAdipolo
madopiMadopi

BidSwitch (All Bidders)

SlugPartner
bidswitchBidSwitch (All Bidders)

bidswitch reaches every bidder BidSwitch trades with, and is for open
deals only. An open deal carries no seats, so it reaches BidSwitch only as a
whole: send bidswitch with no seatIds.

A BidSwitch sub-DSP slug on an open deal becomes bidswitch. However many
BidSwitch buyers an open request names, sub-DSPs or bidswitch, the deal is
created with one bidswitch buyer, in the place of the first of them, and
reads back with it. A PATCH to an open deal's buyers takes them the same
way. An open deal created with a sub-DSP before bidswitch existed reads
back with bidswitch too.

On a pmp deal, name a BidSwitch sub-DSP below with its seats. bidswitch on
a pmp request, or in a PATCH to a pmp deal, whose buyers always carry
seats, returns 400:
body/buyers/0/partner BidSwitch (All Bidders) is for open deals; a pmp deal names a BidSwitch DSP (bsw-*) with its seats.

BidSwitch sub-DSPs

Reached through BidSwitch on a pmp deal: supply the raw DSP seat ID in
seatIds. On an open deal, each of them becomes bidswitch (see
BidSwitch (All Bidders)).

SlugDSP
bsw-ninedotsmedia9 dots media
bsw-adelementAdElement
bsw-adformAdform
bsw-adingeniousAdIngenious
bsw-admaticAdmatic DSP
bsw-admixerAdmixer
bsw-amazonAmazon DSP
bsw-appierAppier
bsw-aroscopAroscop
bsw-azberryAzberry
bsw-bedrockplatformBedrock Platform
bsw-betweenexchangeBetween Exchange
bsw-boldwinBold-win
bsw-criteoCriteo
bsw-edge226Edge226
bsw-igaworksIGAWorks
bsw-instalInstal
bsw-iponwebbidcoreIPONWEB BidCore
bsw-knorexKnorex
bsw-liftLift
bsw-madopiMadopi
bsw-madopimediaMadopi Media
bsw-marketperfMarketperf
bsw-my6sensemy6sense
bsw-nrichN.RICH
bsw-nextrollNextRoll
bsw-samsungSamsung DSP (AdGear)
bsw-sportradarSportradar
bsw-taptapTAPTAP
bsw-webeyeWebeye
bsw-yahooYahoo DSP
bsw-zetaglobalZeta Global DSP

DV360 requirements

A deal whose buyers include dv360 is also created on DV360's side (an
Auction Package for open deals, a Deal Sync product for pmp), and DV360
requires fields this API otherwise treats as optional. A request with a
dv360 buyer must meet all of the following, or it returns 400:

FieldRequirement
descriptionRequired. At most 2000 characters for open deals, 250 for pmp.
schedule.endDateRequired, and later than schedule.startDate. On a pmp deal, in 2030 or earlier.
schedule.startDateWithin 365 days of today (UTC).
pricing.floorRequired, with at most 6 decimal places.
nameAt most 240 characters.
environmentsCannot include dooh: DOOH isn't available on DV360 deals.

pricing.floor must also be greater than 0, but that rule applies to every
deal, and its message does not name DV360:
body/pricing/floor Too small: expected number to be >0.

The messages for these rules name the field and DV360, and how they arrive
depends on the request. On POST each one carries its field path in the
validation shape (see Errors), several joined
by commas. On PATCH they arrive as one { "message": "…" } with no field
paths, their parts joined by semicolons:

{
  "message": "description is required for DV360 buyers (max 250 characters for pmp deals); schedule.endDate is required for DV360 buyers"
}

A create whose environments include dooh, a dry run included, returns
body/environments environments can't include dooh on a deal with a DV360 buyer, because DOOH isn't available on DV360 deals;
a PATCH gets the same words without the path.

A pmp deal that ends in 2031 or later can't be sent to DV360, so such a
create, a dry run included, returns
body/schedule/endDate schedule.endDate must be in 2030 or earlier for DV360 buyers on pmp deals.
It arrives only when the request breaks no other rule of the body, the Trade
Desk ones included: a create that breaks another rule gets that rule's message
instead, and this one once it is fixed. This 400 comes before the answer to
an invalid query string such as ?dryRun=maybe, the 400 for a take rate your
account may not send, and the 403 for an account not enabled for this API.
An open deal with a dv360 buyer may end in any year.

The same rules apply to the merged result of a PATCH, a PATCH that adds a
dv360 buyer included. So a deal with a dv360 buyer that is missing a field
now required, or whose environments include dooh, must put that right in
the same PATCH. Until it does, every PATCH to that deal is refused, a
status change included.

The end year of a pmp deal is the exception: only a PATCH that sends
schedule.endDate, or adds a dv360 buyer, is held to it, and gets the same
words without the path. A deal that already ends in 2031 or later is not held
to it on any other PATCH, such as a new name. On a PATCH this 400 comes
after every other check this API makes, except the ones for a deal whose Trade
Desk buyer has accepted it (see
Once the Trade Desk buyer has accepted),
and before any 502, such as the one an archived deal returns.

DV360 also fixes a deal's format and its medium type when the deal is created.
On an existing deal with a dv360 buyer:

  • adFormat cannot be changed.
  • environments can change only to a list that keeps the deal's medium type.
  • A PATCH whose environments include dooh is refused even if it also
    removes the dv360 buyer.

To change the format or the medium type, create a new deal request instead. The
medium type DV360 lists a deal under follows from its adFormat and
environments:

Medium typeDeals
TVA banner, video or native deal whose only environment is ctv.
AudioAn audio deal whose only environment is web, or whose only environment is app.
DigitalEvery other deal on web, app or ctv, including any deal with more than one environment. Digital includes CTV.

So a banner, video or native deal on web can add app, and one on web
and app can drop either: it stays Digital. Such a deal cannot go from ctv
alone to ctv and web, or from web and ctv to ctv alone: that moves it
between TV and Digital. An audio deal on web cannot add app: that moves it
from Audio to Digital.

A PATCH that breaks one of these rules returns 400 with a message naming
it. One that would change the medium type names the change:

{
  "message": "environments can't change from ctv to ctv, web on a deal with a DV360 buyer, because that would change the deal's DV360 medium type; create a new deal request instead"
}

One whose environments include dooh gets the dooh message instead, never a
medium-type one.

A PATCH to an open deal whose buyers leave dv360 out removes it: its
Auction Package is archived. DV360 can't be added back to that deal. A PATCH
that names dv360 again returns 400, changes nothing, and says so:

{
  "message": "buyers can't add dv360 back: it was removed from this deal; create a new deal request instead"
}

To reach DV360 again, create a new deal request (see
Editing an open deal's buyers).

The Trade Desk requirements

A pmp deal whose buyers include thetradedesk needs an end date, and, while
Sovrn has The Trade Desk's integration on, a floor when its price is fixed, or
it returns 400:

FieldRequirement
schedule.endDateRequired, and before the same calendar date 2 years after schedule.startDate, so the day before it at the latest (28 February for a deal that starts on 29 February).
pricing.floorRequired when pricing.model is fixed, while Sovrn has The Trade Desk's integration on.

So a deal that starts on 2027-06-15 may end on 2029-06-14 at the latest. An
open deal with a thetradedesk buyer is not affected.

On POST, a dry run included, the message arrives in the validation shape (see
Errors):

{
  "statusCode": 400,
  "code": "FST_ERR_VALIDATION",
  "error": "Bad Request",
  "message": "body/schedule/endDate schedule.endDate is required for Trade Desk buyers on pmp deals"
}

An end date too far out gets
body/schedule/endDate schedule.endDate must be within 2 years of schedule.startDate for Trade Desk buyers on pmp deals,
and a fixed price with no floor gets
body/pricing/floor pricing.floor is required for Trade Desk buyers on pmp deals with pricing.model fixed.
A deal that breaks both rules gets only the end-date message, and the floor
one once the end date is fixed. A create that also fails validation on another
field of the body (a body/… message) gets only that message, and this one
once it is fixed. This 400 comes before the answer to an invalid query string
such as ?dryRun=maybe, the 400 for a take rate your account may not send,
the 403 for an account not enabled for this API, and any 502. A create that
breaks these rules gets this 400 even when one of those would also apply.

A PATCH that sends schedule.startDate, schedule.endDate or buyers is held
to the same rules on the deal it would leave, and gets the same words without
the path, as { "message": "…" }. While Sovrn has The Trade Desk's integration
on, so is a PATCH that sends pricing.model or pricing.floor. So a PATCH
that adds a thetradedesk buyer to a pmp deal with no end date must add an
end date too, and, while the integration is on, one that sets pricing.model
to fixed on a deal with no floor must send pricing.floor too. Any other
PATCH is not held to them: a pmp deal with a thetradedesk buyer and no
end date still takes a new name or description, for example, and a new floor
while the integration is off. On a PATCH this 400 comes after every other
check this API makes, except DV360's end year for a pmp deal (see
DV360 requirements) and the ones for an accepted deal
below, and before any 502, such as the one an archived deal returns: a
PATCH that an earlier rule refuses gets only that rule's message.

Once the Trade Desk buyer has accepted

Once the thetradedesk buyer has accepted a pmp deal on The Trade Desk, and
while Sovrn has The Trade Desk's integration on, a PATCH that changes any of
these returns 400:

FieldRefused when
The first seat in the thetradedesk buyer's seatIdsAlways. Its other seats can change.
schedule.startDateThe deal's start date is today or earlier.
schedule.endDateThe deal's end date has passed, or the new end date is in the past.

Dates are calendar dates in UTC. A start date counts as passed from its own
day, because the flight starts at the beginning of it, so a deal that starts
today can no longer move its start. An end date has passed only once it is
before today, so a deal that ends today can still move its end to today or
later. A PATCH that leaves
all three as they are is not held to these rules, such as one that sends the
end date the deal already has, and the seat rule applies only to buyers that
include thetradedesk. No PATCH is held to them before the buyer accepts the
deal, or while Sovrn has The Trade Desk's integration turned off: if Sovrn turns
it off, an accepted deal takes these edits again. An open deal with a
thetradedesk buyer is not affected.

Each refusal arrives as { "message": "…" } and names the field:

{
  "message": "schedule.endDate can't change once it has passed on a pmp deal the Trade Desk buyer has accepted"
}

The others read
buyers can't change the first seat in the thetradedesk buyer's seatIds on a pmp deal the Trade Desk buyer has accepted; create a new deal request instead,
schedule.startDate can't change once it has passed on a pmp deal the Trade Desk buyer has accepted
and
schedule.endDate can't be in the past on a pmp deal the Trade Desk buyer has accepted.
A PATCH that breaks more than one gets their messages in one message,
separated by semicolons. These 400s come after every other check this API
makes, the end-date and floor rules above included, and before the 502 an
archived deal returns. A PATCH refused this way changes nothing.

What a read reports for the Trade Desk buyer

While Sovrn has The Trade Desk's integration on, GET /deal-requests/{id}
reports where the thetradedesk buyer stands with the deal, such as
awaiting_acceptance or change_rejected, in buyerStatuses (see
The Trade Desk buyer's status).

An issue that was not raised about a value in the deal, such as Sovrn failing
to reach The Trade Desk, is on Sovrn's side rather than the buyer's. It arrives in
buyerIssues with no field and the message
Sovrn could not confirm this deal with this buyer's platform., and while the
integration is on it can appear whatever the deal's status (see
When a buyer does not accept a deal).

Deals you can pause yourself

Most DSPs leave a deal's status to you: PATCH /deal-requests/{id} with a
status pauses, resumes, schedules or archives the deal (see
Deal lifecycle).

dv360 is one exception. DV360 manages the status of its own deals through its
integration, and this API does not change it. A deal whose buyers are all
dv360 therefore rejects status:

{
  "message": "status is not settable on this deal: every buyer is on a DSP that manages deal status through its own integration (dv360)"
}

A deal that mixes dv360 with other buyers accepts the change: the other
buyers are set, the dv360 buyer is left as it is, and the deal's own status
is worked out from all of its buyers together. So only paused on a pmp deal
always resolves as sent. Any other value resolves as sent only if the dv360
buyer is already in that state on DV360's side, and otherwise the deal reads
back review; a deal you tried to archive that way stays in list results.

thetradedesk joins that rule on pmp deals once Sovrn turns on The Trade
Desk's integration, which manages the status of its private marketplace deals
from then on. A pmp deal whose buyers are all thetradedesk then rejects
status with the same 400, naming thetradedesk, and a pmp deal that mixes
it with other buyers accepts the change for the other buyers only. On a mixed
deal like that, the status you send resolves as sent only if the
thetradedesk buyer is already in that state on The Trade Desk's side;
otherwise the deal reads back review. A thetradedesk buyer on an open
deal stays settable, before and after.

You do not have to track which DSPs are which. GET /deal-requests/{id} and
the 200 from a PATCH carry a statusSettable boolean that answers it for
that deal (list items and the 201 from a create do not), and it is false
for the mixed cases above too, because the status such a deal resolves to is
not always the one you sent. See
Deal lifecycle.


Did this page help you?