ads

PUT /v1/ads/connections/{connection_id}/placement-goals/{campaign_id}

Set a campaign's top-of-page goal — it sends nothing to the ad account (za-187).

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}/placement-goals/{campaign_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "keywords": <string[]>, "share_pct": <integer> }'

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.placement_goal_set. Replaces the campaign's goal; the account's audit starts at once so it is measured today. A goal is a target, never a change: below target the audit proposes its fixes as one finding a person applies (approve-first, each with its Undo). 422 badPick names the field that is missing or wrong; 404 for a Search campaign the daily audit has not read.

Parameters

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

Request body

NameTypeRequiredWhat it is
keywordsstring[]YesThe campaign's main keywords.
placementstring<top, absolute_top>No—
share_pctintegerYesThe target share of the placement.
max_cpc_microsintegerNo—
daily_budget_microsintegerNo—

Response

NameTypeRequiredWhat it is
dataAdsPlacementGoalYesOne campaign's top-of-page goal and the daily audit's latest reading of it (za-187).

Errors this endpoint can return

401 · 403 · 404 · 422 · 429