ads

POST /v1/ads/connections/{connection_id}/rules

Create a rule; it runs on its own daily Temporal schedule (za-196).

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 POST https://api.zinndigital.com/v1/ads/connections/{connection_id}/rules \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "metric": <string<cost, cost_without_conversions, clicks, impressions, conversions, cpa, ctr, conversion_rate, roas>>, "window_days": <integer<1, 3, 7, 14, 30>>, "comparator": <string<gt, gte, lt, lte>>, "threshold": <integer>, "action": <string<notify, pause_campaign, budget_down, budget_up>> }'

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.rule_create. Only the closed sets of the catalogue are accepted — no expression, formula or code (422 badRule, details[0].field names the field). Money thresholds are integer minor units of the account's currency (§2.8). A rule's write goes through the approve-first change queue and every guard a write passes (kill switches, good standing, the spend ceilings, owner-locked campaigns, the 14-day bid-strategy freeze, the ad-quality gate) and keeps its 30-day Undo. mode: approve (the default) queues each change for a person; auto sends it (a plan without autopilot still queues it). A rule that acted on a campaign does not act on it again inside cooldown_days. Google accounts only (422 rulesGoogleOnly).

Parameters

NameTypeRequiredWhat it is
connection_id (path)stringYes—

Request body

NameTypeRequiredWhat it is
namestringNo—
metricstring<cost, cost_without_conversions, clicks, impressions, conversions, cpa, ctr, conversion_rate, roas>No—
window_daysinteger<1, 3, 7, 14, 30>No—
comparatorstring<gt, gte, lt, lte>No—
thresholdintegerNo—
actionstring<notify, pause_campaign, budget_down, budget_up>No—
action_pctobjectNoThe budget step, for budget_down / budget_up only.
modestring<approve, auto>NoDefault approve: each change waits for a person.
cooldown_daysintegerNoDefault 7.
campaign_idsstring[]NoCampaigns the rule reads; empty = every enabled campaign.
hour_utcintegerNoWhen its daily schedule fires (default 11, after the morning audit stores yesterday's figures).
enabledbooleanNoDefault true.
namestringYes—
metricstring<cost, cost_without_conversions, clicks, impressions, conversions, cpa, ctr, conversion_rate, roas>Yes—
window_daysinteger<1, 3, 7, 14, 30>Yes—
comparatorstring<gt, gte, lt, lte>Yes—
thresholdintegerYes—
actionstring<notify, pause_campaign, budget_down, budget_up>Yes—

Response

NameTypeRequiredWhat it is
dataAdsRuleYes—

Errors this endpoint can return

401 · 403 · 404 · 422 · 429