ads

PATCH /v1/ads/connections/{connection_id}/site-guard-settings

Hosting-aware ads — the switch and thresholds (za-207).

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-guard-settings \
  -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_settings (before/after). A partial update of the customer's own values; reset: true restores every recommended value. Every guard of the account is re-judged on Temporal against the site's state now. Refusal siteGuardInvalid (422) names the field outside its bounds (docs/1006 §64a).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
autobooleanNo—
down_minutesintegerNo—
slow_msintegerNo—
recovery_minutesintegerNo—
resetbooleanNo—

Response

NameTypeRequiredWhat it is
dataAdsSiteGuardSettingsYesza-207 (docs/1006 §64a): hosting-aware ads for one account. Every number is the customer's own; recommended holds our defaults (for "Reset to recommended") and bounds the…

Errors this endpoint can return

401 · 403 · 404 · 422 · 429