Documentation and GuidesAPI Reference
HomeDocumentation and GuidesAPI Reference
Keep this version as our default, as all of our definition IDs point to this
API Reference

Create a new deal

post
https://apps.hivestack.com/api/v2/deals/

Create a new deal

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A payload containing the fields required to create a deal.

string | null
required
date
required
date
required
boolean

The base CPM value derived from the unit's Floor CPM. Used to automate pricing based on established rate card minimums. One of cpm_from_rate_card or cpm_fixed must be set. Can't be set if cpm_fixed is also set.

number | null

One of cpm_from_rate_card or cpm_fixed must be set. Can't be set if cpm_from_rate_card is set.

integer | null
0 to 180
integer | null
0 to 180
string
enum

"FIRST_PRICE" or "FIXED_PRICE"

Allowed:
dsp_ids
array of integers

List of DSP IDs for Open Deals. Used to make inventory available to all buyers on the specified DSPs. Internal and external DSPs cannot be mixed in a single deal. At most one internal DSP may be specified.

dsp_ids
buyer_organization_dsp_ids
array of integers

List of specific DSP organization IDs for PMP Deals. Restricts bidding access to only the listed organizations. Internal and external buyer organization DSPs cannot be mixed in a single deal.

buyer_organization_dsp_ids
curator_organization_ids
array of integers

List of organization IDs for Curated Deals. Limits deal access and management to the specified curators.

curator_organization_ids
string
length between 168 and 168

168 character string of 1 or 0 representing each hour in a week, eg "1001111...1010111"

demographic_ids
array of integers

For demographic targeting

demographic_ids
inventory_targeting
object
boolean

Boolean flag for deals with no expiration date. Indicates the deal remains active indefinitely until manually paused or archived.

package_properties
array of objects
package_properties
package_targetingcriteria
array of objects

Rule-based logic for Event Targeting. Used to trigger the deal based on external conditions like weather or live data.

package_targetingcriteria
string
enum
required

Only 'NG' (guaranteed) is supported for now

Allowed:
string | null

Unique identifier (random prefix + package id). For API calls that require an id to specify a deal, use package_id

Responses

Updated 16 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago

Did this page help you?