ads

PATCH /v1/ads/connections/{connection_id}/site-guards/{guard_id}

Switch a site guard on or off, or change its campaigns (za-N1).

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}/site-guards/{guard_id} \
  -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.site_guard_update. Switching a holding guard off re-enables the campaigns it paused; switching it on while the site is down holds them.

Parameters

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

Request body

NameTypeRequiredWhat it is
enabledbooleanNo—
campaign_idsstring[]No—

Response

NameTypeRequiredWhat it is
dataAdsSiteGuardYesza-N1 (docs/1006 §91): an uptime monitor guarding an ad account. state is watching (nothing held) or holding (campaigns paused by the guard, listed in held).

Errors this endpoint can return

401 · 403 · 404 · 422 · 429