API Reference
Advertiser APIs HomeGuidesAPI ReferenceChangelog

Partially update a line item

patch
https://{buzz_key}.api.beeswax.com/rest/v2/line-items/

Partially update one or more fields of a line item by ID.

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

A unique integer value identifying this line item.

Body Params
integer

The unique identifier of the campaign the line item belongs to.

string
length ≤ 280

The descriptive name of the line item, e.g. "Spring lead generation".

boolean
Defaults to false
string | null

The type of the line item. One of: "banner", "video", "native".

integer | null

The unique identifier of the bid modifier. If it is set, max_bid must also be specified.

integer | null

The unique identifier of the delivery modifier.

integer | null

The unique identifier of the targeting expression.

date-time | null
date-time | null
string | null

An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.

string | null

Free-form notes of up to 255 characters.

string

The currency code in which both lifetime and daily budgets are expressed, e.g. USD.

boolean

Whether the line item is programmatically guaranteed.

string | null

The minimum bid after taking into consideration any bid modifier, e.g. 1.23.

string | null

The maximum bid after taking into consideration any bid modifier, e.g. 7.89.

bidding
object | null

The configuration of the bidding strategy and its related settings. It may include information such as the bidding algorithm used and any additional parameters or constraints. Note: When updating the pacing option for the same strategy via a PATCH call, the fields pacing_behavior, multiplier, and catchup_behavior will be reset to their default values.

skad_network
object | null

The configuration of the SKAd network.

revenue
object | null

The configuration of the revenue.

string | null

The type of the budget. One of: "spend", "impressions", "spend including vendor fees".

spend_budget
object | null

The representation of the budget if the budget type is either "spend" or "spend including vendor fees". If the budget type is "impressions", null will be populated.

impressions_budget
object | null

The representation of the budget if the budget type is "impressions". If the budget type is either "spend" or "spend including vendor fees", null will be populated.

enum

Options field to calculate carry-budget over and total budget for flights depends on selection calculate carry/total budget.Requires at least two flights; if only one or no flights are configured, the request will be rejected.

  • None - None
  • carry_over - Carry Over
  • evenly_distribute - Evenly Distribute
  • prorated_distribute - Prorated Distribute
  • None - None
  • carry_over - Carry Over
  • evenly_distribute - Evenly Distribute
  • prorated_distribute - Prorated Distribute
vendor_fees
array of objects

The list of the vendor fees objects.

vendor_fees
active_flights
array of objects

The list of flights with an end date greater than the current time.

active_flights
ghost_bidding
object | null

The configuration of the ghost bidding. This is used to assess media buy impact by predicting ad outcomes without sending them to the exchange.

event_ids
array of integers

The list of the unique identifiers representing the associated events.

event_ids
frequency_caps
object | null

The configuration of the frequency capping.

segment_extension
object | null

The configuration of the segment extension.

integer | null

The unique identifier of the test group. This field is used when using Experiments to separate users into different groups for testing purposes.

user_timezones
array of strings
user_timezones
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Invalid data provided for partial update.

404

The specified line item does not exist.

Updated 4 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 4 months ago