ads

PATCH /v1/ads/connections/{connection_id}/organic

Pick the Search Console property and edit the paid-vs-organic saver (za-191, za-N3).

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 PATCH https://api.zinndigital.com/v1/ads/connections/{connection_id}/organic \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

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.organic_settings. Every threshold is the customer's; each must sit inside its bounds. Where the site ranks at the top organically (organic_top_position, with organic_min_clicks) and paid adds nothing measured (organic_paid_min_clicks clicks, no conversion), the daily audit PROPOSES lowering the bid by organic_lower_pct or pausing the keyword (organic_saver_action); where organic is weaker than organic_weak_position and the keyword converts, it proposes raising the bid by organic_raise_pct. Every proposal waits for approval in the changes queue; a keyword proposed is left alone for organic_cooldown_days. site must be one of the properties listAdsOrganicSites returns (empty string stops the reading). 422 organicInvalid (the field is named) · organicSiteUnknown · organicNeedsScope · organicUnavailable · organicGoogleOnly.

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
sitestringNo—
organic_saver_modestring<suggest, off>No—
organic_top_positionnumberNo—
organic_min_clicksintegerNo—
organic_paid_min_clicksintegerNo—
organic_saver_actionstring<lower, pause>No—
organic_lower_pctintegerNo—
organic_weak_positionnumberNo—
organic_raise_pctintegerNo—
organic_cooldown_daysintegerNo—

Response

NameTypeRequiredWhat it is
dataAdsOrganicYesza-191 / za-N3 (docs/1006 §78): paid beside organic for one Google Ads account, and the saver's thresholds.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429