Ads · Ad Rules
Creates an ad rule.
https://api.pozy.ai/v1/ads/rulesGuide: Automated ad rules
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the ads resource group disabled get 403 resource_group_disabled. Authentication
Request body
application/json, required
namestringrequired1 to 200 characters.
accountIdstringrequiredadAccountIdstringrequiredlevelstringrequiredOne of
campaign,adset,ad.campaignIdsarray of stringAt least 1 item. Up to 100 items.
conditionsobjectrequiredallarray of objectrequiredAt least 1 item. Up to 10 items.
4 child fields
metricstringrequiredOne of
spend,impressions,clicks,conversions,ctr,cpc,cpm,cpa,roas,reach,frequency.windowstringrequiredOne of
today,yesterday,last_3d,last_7d,last_14d,last_30d.opstringrequiredOne of
>,>=,<,<=.valuenumberrequiredAt least 0.
actionsarray of objectrequiredAt least 1 item.
One of:
Option 1 (1 fields)
typestringrequiredOne of
notify.
Option 2 (2 fields)
typestringrequiredOne of
pause.maxChangesPerDayinteger1 to 100.
Option 3 (2 fields)
typestringrequiredOne of
activate.maxChangesPerDayinteger1 to 100.
Option 4 (5 fields)
typestringrequiredOne of
adjust_budget.directionstringrequiredOne of
increase,decrease.percentintegerrequired1 to 100.
limitnumberrequiredmaxChangesPerDayinteger1 to 100.
scheduleobjecteveryMinutesintegerrequiredOne of
60,180,360,720,1440.
cooldownMinutesintegerDefault
1440. 0 to 43200.enabledbooleanDefault
true.
Example
curl -X POST "https://api.pozy.ai/v1/ads/rules" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme",
"accountId": "696e0b682d0a31188e7a2ba9",
"adAccountId": "666219aad7bab67ace411e4f",
"level": "campaign",
"conditions": {
"all": [
{
"metric": "spend",
"window": "today",
"op": ">",
"value": 12.5
}
]
},
"actions": [
{
"type": "notify"
}
]
}'const res = await fetch("https://api.pozy.ai/v1/ads/rules", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Acme",
accountId: "696e0b682d0a31188e7a2ba9",
adAccountId: "666219aad7bab67ace411e4f",
level: "campaign",
conditions: {
all: [
{
metric: "spend",
window: "today",
op: ">",
value: 12.5
}
]
},
actions: [
{
type: "notify"
}
]
}),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.post(
"https://api.pozy.ai/v1/ads/rules",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"name": "Acme",
"accountId": "696e0b682d0a31188e7a2ba9",
"adAccountId": "666219aad7bab67ace411e4f",
"level": "campaign",
"conditions": {
"all": [
{
"metric": "spend",
"window": "today",
"op": ">",
"value": 12.5,
},
],
},
"actions": [
{
"type": "notify",
},
],
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
201 on success
ruleobjectrequired16 child fields
idstringrequirednamestringrequiredaccountIdstringrequiredplatformstringrequiredadAccountIdstringrequiredlevelstringrequiredOne of
campaign,adset,ad.campaignIdsarray of stringrequiredCan be null.
conditionsobjectrequired1 child field
allarray of objectrequiredAt least 1 item. Up to 10 items.
4 child fields
metricstringrequiredOne of
spend,impressions,clicks,conversions,ctr,cpc,cpm,cpa,roas,reach,frequency.windowstringrequiredOne of
today,yesterday,last_3d,last_7d,last_14d,last_30d.opstringrequiredOne of
>,>=,<,<=.valuenumberrequiredAt least 0.
actionsarray of objectrequiredAt least 1 item.
One of:
Option 1 (1 fields)
typestringrequiredOne of
notify.
Option 2 (2 fields)
typestringrequiredOne of
pause.maxChangesPerDayinteger1 to 100.
Option 3 (2 fields)
typestringrequiredOne of
activate.maxChangesPerDayinteger1 to 100.
Option 4 (5 fields)
typestringrequiredOne of
adjust_budget.directionstringrequiredOne of
increase,decrease.percentintegerrequired1 to 100.
limitnumberrequiredmaxChangesPerDayinteger1 to 100.
scheduleobjectrequired1 child field
everyMinutesintegerrequiredOne of
60,180,360,720,1440.
cooldownMinutesintegerrequiredenabledbooleanrequiredlastRunAtstring (date-time)requiredCan be null.
nextRunAtstring (date-time)requiredCan be null.
createdAtstring (date-time)requiredupdatedAtstring (date-time)required
{
"rule": {
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"accountId": "696e0b682d0a31188e7a2ba9",
"platform": "instagram",
"adAccountId": "666219aad7bab67ace411e4f",
"level": "campaign",
"campaignIds": [
"string"
],
"conditions": {
"all": [
{
"metric": "spend",
"window": "today",
"op": ">",
"value": 12.5
}
]
},
"actions": [
{
"type": "notify"
}
],
"schedule": {
"everyMinutes": 60
},
"cooldownMinutes": 1,
"enabled": true,
"lastRunAt": "2026-10-02T09:00:00.000Z",
"nextRunAt": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z",
"updatedAt": "2026-10-02T09:00:00.000Z"
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is read-only, scoped to other profiles, or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.