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

Update a line item

put
https://apps.hivestack.com/api/v2/lineitems/

Updates a line item associated to your organization.

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

A payload containing required line item fields.

integer
0 to 60
Defaults to 10

Duration of the ad in seconds. Put 0 to match Based on Screen behaviour. Default value is 10

number
Defaults to null

Budget associated to the line item. Only populate this field if the budget_mode is set to "B".

string
enum

Specifies whether the line item should be delivered on ad spend (B) or impressions (I).

Allowed:
number

A positive value which represents the number of plays per hour goal for a cadence buy lineitem.

boolean
Defaults to false

A boolean which default to false, that allows to fluctuate cadence in an attempt to reach the final budget of a cadence buy lineitem.

integer

Id of the campaign associated to the line item.

number
Defaults to null

Daily Spend Cap associated to the line item.

number

Fixed CPM rate. Only populate this field if is_cpm_from_rate_card is false.

lineitem_properties
array of objects
lineitem_properties
lineitem_targetingcriteria
array of objects
lineitem_targetingcriteria
creative_ids
array of integers
Defaults to []

List of creatives to target with the line item.

creative_ids
string
Defaults to 111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111

A sequence of 7 x 24 = 168 "0"s and "1"s representing the hours in a week. A "1" signifies that the line item will be active during the hour and a "0" signifies that the line item will be inactive during the hour. The first hour of the sequence is Monday 12:00 A.M. and the last hour is Sunday 11:00 P.M.

string
enum
Defaults to audience

Equivalent to pacing strategy on the Ui. Determines the pacing strategy that will be used to used to spend the budget.

  • linear: Budget spent uniformly over the duration of the campaign.
  • sqrt: (ahead on the Ui) Budget spent by applying a faster delivery rate at the beginning and gradually lowering the rate of delivery as the campaign progresses.
  • audience: (optimized on the Ui) Distributes the budget according to audience density and concentration, and to distribute spend evenly across weeks.
  • fastest: (ASAP on the Ui) Budget spent as fast as possible. Default delivery_curve is audience
Allowed:
demographic_ids
array of integers
Defaults to []

List of audiences to target with the line item. Please refer to public endpoint to see available values.

demographic_ids
string
Defaults to null

A customizable id to give the line item.

date

The start date of the line item, in YYYY-MM-DD format.

date

The end date of the line item, in YYYY-MM-DD format.

boolean

If true, the CPM will be taken from a rate card. If false, the CPM will be at a fixed rate and cpm_gross must have a value.

integer
Defaults to null

When the budget_mode is set to impressions (I), this field is used to speficy the total number of impressions to target. Only populate this field when budget_mode is "I".

number
Defaults to null

The maximum amount you're willing to spend for 1000 views on your ad.

mediaowner_ids
array of integers
Defaults to []

List of mediaowners. Please refer to public endpoint to see available values. Empty list is not allowed.

mediaowner_ids
number
Defaults to null

You can choose to play this line item when your concentration is at least: market average (1), below market average (between 0.02 and 0.99) or above market average (>1). For example, a ratio of 0.50 will prevent the line item to run if the observed concentration is 50% below market average whereas a ratio of 1.50 will prevent the line item to run if the observed concentration is not at least 50% above market average.

integer
Defaults to 0

Equivalent to frequency cap. Prevents plays from the same campaign for a number of seconds after a play.

string

The name to give the line item.

string
Defaults to null

Additional notes that might be associated with the line item.

integer
enum
Defaults to 5

Optional integer with a value between 1 and 9 (inclusive) used to prioritize the line items of the campaign, 1 being the lowest priority and 9 being the highest priority (opposite of the Ui behaviour where 1 is the highest). If this field is not null, the priority of the line items in the campaign will be overwritten by this value.

string
enum

Determines the type of line item

  • G: Ad server guaranteed.
  • NG: Ad server non-guaranteed.
  • H: House Ad.
  • C: Cadence buy.
  • B: Bonus-Buy.
Allowed:
string
enum
Defaults to P
  • S: Stopped
  • P: Playing Default run_state is P
Allowed:
unit_ids
array of integers
Defaults to []

List of screens to target with the line item. Please refer to public endpoint to see available values.

unit_ids
string
enum
  • D: Draft
  • S: Submitted
  • C: Cancelled
Allowed:
Responses

Updated 2 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago