Skip to main content
PATCH
Update a campaign

Authorizations

Authorization
string
header
required

An API key from Settings → API access, starting with fnd_.

Headers

Idempotency-Key
string

Any unique string. Repeating a request with the same key returns the first result instead of doing it twice.

Maximum string length: 200

Path Parameters

campaignId
string
required

Campaign id.

Pattern: ^[a-f0-9]{24}$

Body

application/json
name
string
Required string length: 1 - 160
objective
string

What the campaign should achieve and for whom. Drives targeting.

Maximum string length: 4000
brandId
string | null

Null removes the brand.

Pattern: ^[a-f0-9]{24}$
industry
string
Maximum string length: 120
language
string

Language code. Default en.

Maximum string length: 20
locations
string[]

Country or region codes, e.g. ["US"]. Default ["US"].

Maximum array length: 20
Maximum string length: 80
successMetrics
string[]
Maximum array length: 20
Maximum string length: 200
campaignType
enum<string>

Google Ads campaign type.

Available options:
SEARCH,
DEMAND_GEN,
VIDEO,
DISPLAY
budget
number | null
Required range: 0 < x <= 10000000
budgetType
enum<string>
Available options:
daily,
total
endDate
string | null

YYYY-MM-DD. Required for a total budget.

Pattern: ^\d{4}-\d{2}-\d{2}$
biddingStrategy
enum<string> | null

Google Ads bidding strategy.

Available options:
MAXIMIZE_CONVERSIONS,
MAXIMIZE_CONVERSION_VALUE,
TARGET_CPA,
TARGET_ROAS,
TARGET_CPC,
TARGET_SPEND,
MANUAL_CPC
targetCpa
number | null
Required range: 0 < x <= 1000000
targetRoas
number | null
Required range: 0 < x <= 1000

Response

Success

id
string
required
name
string
required
status
string
required

draft, loading (collecting data), ready or error.

objective
string
required
brandId
string | null
required
brand
object
required
industry
string
required
language
string
required
locations
string[]
required
successMetrics
string[]
required
campaignType
string | null
required
budget
number | null
required

In the account's currency.

budgetType
enum<string> | null
required
Available options:
daily,
total
endDate
string | null
required
biddingStrategy
string | null
required
targetCpa
number | null
required
targetRoas
number | null
required
audiences
object[]
required
googleAds
object
required
url
string
required

Opens the campaign in Fandom.

createdAt
string | null
required
updatedAt
string | null
required