Create a unit

post

https://apps.hivestack.com/api/v2/units

Creates a unit associated to your organization

Body Params

A payload containing required unit fields

active

boolean

allow_audio

boolean

allow_html

boolean

allow_image

boolean

allow_video

boolean

allow_zip

boolean

available_for_adserver

boolean

available_for_deals

boolean

available_for_open_exchange

boolean

available_for_storefront

boolean

description

string

required

The field that is shown in the UI effectively as its name

enable_strict_iab_blacklisting

boolean

enable_strict_iab_frequency_capping

boolean

external_id

string

required

Your organization's unique identifier so that you can relate a unit in your own inventory system with a unit in our system

facing_direction

string

enum

floor_cpm

number

The lowest CPM at which the unit will receive ad plays

iab_blacklist_categories

array of strings

A list of restricted IAB categories for the unit with format like 'IAB13-12'. Available IAB categories can be found in this Hivestack Knowledge Base article. Will only appear in response payload and can only be updated if '$expand=unit_iab_blacklist' is used in query parameters"

iab_blacklist_categories

image_uri

string

Allow uploading an image of the unit. The value should be a valid URL.

latitude

number

required

longitude

number

required

loop_length

integer

required

max_spot_length

integer

mediatype_id

integer

required

Equivalent to media_type.mediatype_id

min_seconds_between_ad_domain_plays

integer

min_seconds_between_creative_category_plays

integer

min_seconds_between_iab_category_plays

integer

min_spot_length

integer

name

string

required

network_id

integer

required

operating_hours

string

A weekly daypart of when a display is activated for ad delivery represented by 1s and 0s for each hour of the the week beginning on Monday at 12AM

owner_id

integer

required

The ID of the organization that owns the unit

physical_screen_height_cm

number

physical_screen_width_cm

number

physical_unit_count

integer

If there's only one physical unit, then this value will be null. If 1 is provided, it is considered as null

screen_height

integer

required

A unit's height in pixels

screen_width

integer

required

A unit's width in pixels

serial_number

string

The serial number of the unit. If the Perion Player is installed, this value is used to do the first automated sync

site_id

integer

required

spot_length

integer

timezone

string

A timezone in standard database format

uuid

weekly_impressions

integer

deprecated

Response

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK - an object representing a unit