Create a deal request

post

https://api.sovrn.com/sovrnos/v1/deal-requests

Creates the deal in real time and returns the Sovrn external deal ID (SVN_…) synchronously. Pass ?dryRun=true to run the full validation pipeline without creating anything.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

dryRun

string

enum

Defaults to false

Allowed:

Body Params

name

string

required

length ≥ 1

description

string

adFormat

string

enum

required

Allowed:

environments

array of objects

required

length ≥ 1

environments*

Allowed:

pricing

object

required

commercial

object

required

schedule

object

required

buyers

array of objects

required

length ≥ 1

buyers*

partner

string

enum

required

seatIds

array of strings

required

length ≥ 1

seatIds*

runOfNetwork

const

enum

Allowed:

targeting

array of objects

length ≥ 1

targeting

name

string

required

length ≥ 1

rules

array of objects

required

length ≥ 1

rules*

attribute

string

enum

required

Allowed:

values

array

required

length ≥ 1

values*

match

string

enum

Defaults to include

Allowed:

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

text/plain

200Dry-run validation passed; no deal was created.

201Deal created.

400The request failed validation; message names the problem — e.g. takeRate is a decimal fraction; expected 0 ≤ x ≤ 0.85. See the Errors guide.

401The API key was missing or not accepted. Not JSON — a bare text/plain string: api key not provided, invalid api key, or invalid api key syntax.

403The key is valid but not permitted: {"message": "Partner not authorized for this API"} or {"message": "Insufficient scope"}. Checked before body validation — even with ?dryRun=true.

502Sovrn could not reach the downstream deal system; nothing was persisted — safe to retry with a unique name. Carries a required upstream field.