API Reference

/advertising/campaigns/{campaignID}

put
https://www.toneden.io/api/v1/advertising/campaigns/

Update an ad campaign.

Path Params
integer
required

Numeric ID of the ad campaign to update.

Body Params
number
string
string
enum

The platform the ad campaign will be delivering on (Facebook Ads or Google AdWords).

Allowed:
number
string
enum
string

The error message received while creating the ad, if the ad is in 'error' status.

status_log
array of objects

A list of log items detailing actions performed on the campaign, such as updates by the user, automated budget rebalances, and ad approvals/rejections.

status_log
report_emails
array of strings
report_emails
boolean
boolean
Defaults to false
string

The ID of the Facebook pixel that will be used to track conversions in this campaign.

string

The name of the standard conversion event (or ID of the custom conversion event) to optimize this campaign for.

string

The URL to target in link-click and conversion ads, or the ID of the post, event, or product set to promote in post engagement, event RSVP, and dynamic ads, respectively.

string
enum

The type of the campaign objective.

string

For campaigns that have had their target URL masked by a fanlink, this will be the URL of the fanlink. This is always the 'true' target URL of ads in the campaign.

targeting
object

Contains targeting settings which are applied on a campaign-wide level, such as location targeting in Google campaigns.

audiences
array of objects

Array of audience items which will map to adsets in Facebook campaigns, and adgroups in Google campaigns.

audiences
creatives
string
enum
Allowed:
number
string

3-letter currency code that the budget of the campaign is in.

integer

UNIX timestamp representing the date/time the campaign will start running.

integer

UNIX timestamp representing the date/time the campaign will stop running.

boolean

Whether this campaign should run indefinitely. If true, the end_timestamp value is ignored.

string

ID of the Facebook ad account or Google Adwords account which the campaign is running under.

string

ID of the campaign on the external ad platform.

string

ID of the Facebook page running the campaign.

string

If the user manually selected an Instagram account when setting up the campaign, its ID will be stored in this field.

number

The total amount of money the campaign has spent.

integer

The number of unique people who have seen ads in this campaign.

integer

The total number of clicks that ads in this campaign have received.

integer

The total number of purchases that have been driven by this campaign.

integer

The number of the target event (clicks for link click campaigns, View Content events for conversion campaigns optimizing for View Content, post engagements for post engagement campaigns) that have occurred as a result of this campaign.

number

The ratio of views of ads in this campaign to conversions.

number

The monetary value of purchases driven by this campaign.

number

The average cost to drive a conversion.

number

The average cost to drive a click.

number

The ratio of views of ads in this campaign to clicks.

number

For growth campaigns, the total number of followers the user has on the growth platform.

number

For growth campaigns, the number of followers the user had on the growth platform when the campaign started.

Response

Updated over 5 years ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 5 years ago