ads

PUT /v1/ads/connections/{connection_id}/objectives/{campaign_id}

Propose a campaign's objective — approve-first, it changes nothing yet (za-184).

All ads endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PUT https://api.zinndigital.com/v1/ads/connections/{connection_id}/objectives/{campaign_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "objective": <string<leads, revenue, profit, top_of_page, brand_defence, traffic, reach, none>> }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.manage; audit action ads.objective_propose. Stores the proposal as pending; a person approves it (approveAdsCampaignObjective) before it is in force. objective: none proposes clearing it. Each objective needs its own fields: leads a target_cpa_micros; revenue a target_roas_pct (400 = 4.00x); profit a margin_pct (the target return is break-even, 100 / margin); top_of_page a share_pct, a placement and a max_cpc_micros; brand_defence a max_cpc_micros (90% at absolute_top unless given); traffic an optional max_cpc_micros; reach (za-201) an optional max_cpm_micros, and only on a VIDEO / DEMAND_GEN campaign of a connection whose YouTube channel is saved (putAdsVideo; otherwise 422 badPick on objective). Money is integer micros of the account's currency. 422 badPick names the field that is missing or wrong; 404 for a campaign the daily audit has not read.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—
campaign_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
objectivestring<leads, revenue, profit, top_of_page, brand_defence, traffic, reach, none>Yes—
target_cpa_microsintegerNo—
target_roas_pctintegerNo400 = a 4.00x return.
margin_pctintegerNo—
share_pctintegerNo—
placementstring<anywhere, top, absolute_top, >No—
max_cpc_microsintegerNoThe max-CPC limit; never sent above 3x the campaign's own 30-day average cost per click.
max_cpm_microsintegerNoReach only (za-201): the most 1,000 people reached may cost; 0 is no limit.

Response

NameTypeRequiredWhat it is
dataAdsCampaignObjectiveRowYesOne campaign's objective, its proposal and the judgement against it (za-184).

Errors this endpoint can return

401 · 403 · 404 · 422 · 429