ads

POST /v1/ads/shield/exclusions/{exclusion_id}/undo

Undo one click-shield exclusion (one click).

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.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

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

curl -X POST https://api.zinndigital.com/v1/ads/shield/exclusions/{exclusion_id}/undo \
  -H "Authorization: Bearer zdk_live_…"

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 (IPROTATE, za-59). The person's click approves the removal of that one exclusion at Google (sent by the apply workflow, through the metered driver) and the exclusion is never proposed again for its campaign. Refused (422) when it is not at Google (notApplied), Google has not confirmed it yet (notYetAtGoogle), a removal is already on its way (alreadyRemoving) or it was applied more than 30 days ago (refusal.adsconnect.undoExpired, the same undo window as every Zinn® Ads change). The daily e-mail's Undo link for one exclusion runs this same path through actOnAdsEmailLink. A Microsoft website exclusion is removed from the campaign's list the same way; a Meta listed one only leaves the Zinn-held block list (nothing is sent to Meta) and is never listed again.

Parameters

NameTypeRequiredWhat it is
exclusion_id (path)stringYes—
org_id (query)stringNo—

Response

NameTypeRequiredWhat it is
idstringYes—
connection_idstringYes—
campaign_idstringYesEmpty for an account-level exclusion.
kindstring<ip, placement, audience>Yes—
value_maskedstringYesAn IP exclusion as its network (/24 or /48) — never the whole address; a placement as its URL; an audience as its user list / interest resource name.
levelstring<campaign, account>Yesaccount = an account-level placement exclusion (how Google takes one for Performance Max).
last_cost_atobjectYesThe newest suspected click from this source that cost money; within the connection's shield_stale_days it is never rotated out.
applied_atobjectYes—
removed_atobjectYesWhen it was rotated out; a source that comes back is judged only on clicks after this.
can_undobooleanYesThe network holds it and no removal is on its way — or it is listed (Meta: Undo only takes it off the list): the one-click Undo works.
measured_cost_minorintegerYesWhat the source cost the campaign (estimated, integer minor units).
currencystringYes—
clicksintegerYes—
criterionstring<, placement, mobile_application, youtube_channel, youtube_video, user_list, user_interest>YesWhich criterion value_masked fills (za-N18): a website URL, an app id, a YouTube channel or video id, an audience; empty for an IP.
display_namestringYesThe placement's name as Google shows it (an app's or a channel's title).
reasonstring<, waste, junk>YesWhy a placement was proposed: it spent with no result (waste) or belongs to a junk class (junk).
junk_classstring<, mobile_app, kids, parked, mfa>Yesparked = a parked / for-sale domain page; mfa = a made-for-ads site (two or more named signals; always approve-first).
platformstring<google, microsoft, meta, linkedin, tiktok, x, pinterest, amazon, chatgpt>YesPLACEGUARD2: the connection's network. A Meta exclusion is only ever listed.
statusstring<queued, applied, rejected, removed, undone, failed, listed>Yeslisted (Meta) = on the connection's Zinn-held block list: nothing was sent, because Meta's API does not let us apply a block list (it needs app permissions our Meta app does not…
change_idobjectYesThe ad-account change that adds it (approve / Undo there).
remove_change_idobjectYesThe change that rotates it out, when one is waiting or done.
created_atstringYes—
updated_atstringYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429