Guides
API Reference

campaign

put
https://asx-api.bidtheatre.com/v2.0/api//campaign/
Path Params
integer
required
integer
required
Body Params
integer

A unique id for this campaign

integer
required

The advertiser this campaign belongs to

string
required

This campaign's name

string | null

Where to send user on click

string | null

Landing page at advertiser

string | null
required

The campaign manager receives important campaign mails

string | null

The sales manager receives important campaign mails regarding the campaigns finance

string | null

The utm_source parameter used for tracking traffic in Google Analytics

string | null

The utm_medium parameter used for tracking traffic in Google Analytics

string | null

The utm_content parameter used for tracking traffic in Google Analytics

string | null

The utm_campaign parameter used for tracking traffic in Google Analytics

integer | null

Sets revenue model. Choose 'At cost' if uncertain

integer | null

Only used for campaigns with the Cost Per Conversion KPI selected. Identifies the conversion tracker to be optimized against

boolean | null

Indicates if screenshots should be taken automatically

integer | null

If set, a campaign report is automatically sent to the CM on campaign end

number | null

The frontload factor is the extra percentages that you'd like the campaign to be delivered at 50 % of the campaign time.

string | null
enum

The delivery priority. Only updatable on PATCH.

Allowed:
integer | null

Frequency capping limit. Only updatable on PATCH.

integer | null

Time until counter reset after capping limit reached (hours). Only updatable on PATCH.

boolean | null

Indicates if wide targeting should be allowed. Only updatable on PATCH.

boolean | null

Indicates whether the online behavioral advertising (OBA) information should be displayed alongside the ad creatives. Only updatable on PATCH.

string | null

Optional order id for cross reference against other systems. Only updatable on PATCH.

integer | null

Default geo target to use on this campaign. Only updatable on PATCH.

integer | null

Default audience to use on this campaign. Only updatable on PATCH.

integer | null

Default filter target to use on this campaign. Only updatable on PATCH.

integer | null

Default optimization strategy to use on this campaign. Only updatable on PATCH.

integer | null

The desired campaign KPI for this campaign. Only updatable on PATCH.

number | null

The default max CPM value. Only updatable on PATCH.

integer
enum

Version 1 indicates a campaign created following the old standards. Version 2 indicates a campaign created following the new standards using default objects and isn't visible in our old GUI. Not updatable.

Allowed:
number | null

The default max CPC value. Only updatable on PATCH.

boolean | null

Governs how under delivered cycles are handled. If set unspent targets isn't used for later cycles. Not updatable.

boolean

Filter campaigns based on whether they are terminated or not

integer

Filter campaigns based on assigned geo target

integer

Filter campaigns based on assigned filter target

integer

Filter campaigns based on assigned audience

boolean

Indicates if this campaign have active alerts

boolean

Filter campaigns based on whether they originates in a bundle or not

string

Filter campaigns based on assigned labels

integer

Used for filtering when path filter can't be used

Responses

Updated about 1 month ago

Language
Credentials
Bearer
Bearer <token>
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago