v2

Update fields for one or more ads, targeted by campaignId.

post/v2/campaign/update

Request

  • Base URL: https://api.inside.ad/api
  • URL: https://api.inside.ad/api/v2/campaign/update
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://api.inside.ad/api/oauth/authorize, token URL https://api.inside.ad/api/oauth/token, scopes: ads:write)
    • API key in header authorization

Query parameters

userIdnumber required

userId owner of the campaigns

campaignIdnumber required

campaignId

Request body

categorystring

Ad category slug (e.g. "humor", "education") — a canonical slug, not a numeric index.

targetCountriesstring

JSON array of target countries

targetSubdivisionsstring

JSON array of target regions/subdivisions

targetLanguagesstring

JSON array of target languages

targetCategoriesstring

JSON array of target channels categories

targetKeywordsstring

JSON array of target inclusion keywords

excludedKeywordsstring

JSON array of excluded keywords

statusUserstring

User-facing operational status (a string, not a number), e.g. 'onModeration' to submit/launch, 'onHold' to pause. Only transitions valid for the ad's current state are applied; others are silently ignored.

titlestring

Ad inner system layout title

languageCodestring

General language locale code

mWeeklyBudgetnumber

Weekly budget limit threshold

bodystring

Main content raw message body text

linkstring

Target click URL redirect link

bidCPFnumber

Cost Per Follower target bid limit value

bidCPCnumber

Cost Per Click target bid limit value

bidCPAnumber

Cost Per Action target bid limit value

bidCPC_t2number

Tier-2 (mid GEO) cost-per-click override, milli-USD. 0/omit = use avgBidCPC_t2 (see that ad field for the current value).

bidCPC_t3number

Tier-3 (budget GEO, e.g. India) cost-per-click override, milli-USD. 0/omit = use avgBidCPC_t3 (see that ad field for the current value).

bidCPF_t2number

Tier-2 cost-per-follower override, milli-USD. 0/omit = use avgBidCPF_t2 (see that ad field for the current value).

bidCPF_t3number

Tier-3 cost-per-follower override, milli-USD. 0/omit = use avgBidCPF_t3 (see that ad field for the current value).

bidCPA_t2number

Tier-2 cost-per-action override, milli-USD. 0/omit = use avgBidCPA_t2 (see that ad field for the current value).

bidCPA_t3number

Tier-3 cost-per-action override, milli-USD. 0/omit = use avgBidCPA_t3 (see that ad field for the current value).

bidTypestring

Type of bidding configuration structure

filenamestring

Attached media assets disk location path filename

autonumber

Automation control engine flag

Response

Default Response

successboolean
updatedFieldsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.