Update an ad rule
curl --request PATCH \
--url https://api.aisa.one/apis/v1/ads/rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.aisa.one/apis/v1/ads/rules/{ruleId}"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.aisa.one/apis/v1/ads/rules/{ruleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/rules/{ruleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/ads/rules/{ruleId}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.aisa.one/apis/v1/ads/rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/rules/{ruleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"rule": {
"actions": [
{
"type": "notify"
}
],
"adAccountId": "<string>",
"campaignIds": [
"<string>"
],
"conditions": {
"all": [
{}
]
},
"cooldownMinutes": 123,
"createdAt": "2023-11-07T05:31:56Z",
"enabled": true,
"id": "<string>",
"lastRunAt": "2023-11-07T05:31:56Z",
"level": "campaign",
"name": "<string>",
"nextRunAt": "2023-11-07T05:31:56Z",
"platform": "<string>",
"schedule": {
"everyMinutes": 60
},
"updatedAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>"
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
Update an ad rule
Ad Rules. Can spend money or change spend: needs the ads:spend scope and X-Aisa-Confirm: spend; without the header the request is refused with confirmation_required and nothing is sent. Changes an automated rule that can change budgets and turn delivery on or off. Changes any field of a rule except its connection and ad account. Send `campaignIds: null` to check the whole ad account again. Changing the schedule, or enabling a disabled rule, moves the next run; re-sending `enabled: true` on an enabled rule does not.
<!-- aisa-pricing:start -->
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ.
<!-- aisa-pricing:end -->
PATCH
https://api.aisa.one
/
apis
/
v1
/
ads
/
rules
/
{ruleId}
Update an ad rule
curl --request PATCH \
--url https://api.aisa.one/apis/v1/ads/rules/{ruleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{}'import requests
url = "https://api.aisa.one/apis/v1/ads/rules/{ruleId}"
payload = {}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({})
};
fetch('https://api.aisa.one/apis/v1/ads/rules/{ruleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aisa.one/apis/v1/ads/rules/{ruleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aisa.one/apis/v1/ads/rules/{ruleId}"
payload := strings.NewReader("{}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.aisa.one/apis/v1/ads/rules/{ruleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/rules/{ruleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"
response = http.request(request)
puts response.read_body{
"rule": {
"actions": [
{
"type": "notify"
}
],
"adAccountId": "<string>",
"campaignIds": [
"<string>"
],
"conditions": {
"all": [
{}
]
},
"cooldownMinutes": 123,
"createdAt": "2023-11-07T05:31:56Z",
"enabled": true,
"id": "<string>",
"lastRunAt": "2023-11-07T05:31:56Z",
"level": "campaign",
"name": "<string>",
"nextRunAt": "2023-11-07T05:31:56Z",
"platform": "<string>",
"schedule": {
"everyMinutes": 60
},
"updatedAt": "2023-11-07T05:31:56Z",
"connectionId": "<string>"
}
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: PATCH /apis/v1/ads/rules/{ruleId}
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/rules/{ruleId} - ruleId: path; required
- connectionId: query; required
- X-Aisa-Confirm: header; optional
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "patch_aisa_ads_apis_v1_ads_rules_ruleid",
"method": "PATCH",
"path": "/apis/v1/ads/rules/{ruleId}",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"in": "path",
"name": "ruleId",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.",
"in": "query",
"name": "connectionId",
"required": true,
"schema": {
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
}
},
{
"description": "Required with the value \"spend\" when the request can spend money or change spend. Without it the request is refused with 409 confirmation_required, which describes what would happen; nothing is sent to the ad platform.",
"in": "header",
"name": "X-Aisa-Confirm",
"required": false,
"schema": {
"enum": [
"spend"
],
"type": "string"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"connectionId": "adc_7f3k2m9q",
"enabled": false,
"name": "Winter launch"
},
"schema": {
"additionalProperties": true,
"properties": {
"actions": {
"description": "Each type at most once, and at most one of `pause`, `activate` and `adjust_budget`.",
"items": {
"oneOf": [
{
"properties": {
"type": {
"enum": [
"notify"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"properties": {
"maxChangesPerDay": {
"description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Pause the campaign, ad set or ad.",
"enum": [
"pause"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"properties": {
"maxChangesPerDay": {
"description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Reactivate a campaign, ad set or ad a rule paused, once `cooldownMinutes` has passed since the pause. Objects you paused yourself are never touched.",
"enum": [
"activate"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"properties": {
"direction": {
"enum": [
"increase",
"decrease"
],
"type": "string"
},
"limit": {
"description": "The budget never goes above this on an increase, or below it on a decrease, in the ad account currency.",
"exclusiveMinimum": 0,
"type": "number"
},
"maxChangesPerDay": {
"description": "At most this many objects changed in any 24 hours, across runs. Matches over the limit are skipped with `daily_limit_reached` and tried again later.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"percent": {
"description": "Change in percent: up to 100 for an increase, up to 90 for a decrease.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Change the daily budget. Not on ad-level rules (an ad has no budget), and on Google it needs a campaign-level rule (ad groups have no budget of their own).",
"enum": [
"adjust_budget"
],
"type": "string"
}
},
"required": [
"direction",
"limit",
"percent",
"type"
],
"type": "object"
}
]
},
"minItems": 1,
"type": "array"
},
"campaignIds": {
"description": "Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"type": [
"array",
"null"
]
},
"conditions": {
"description": "Every condition must hold for an object to match. A rate with no denominator (a CPA with no conversions) never matches.",
"properties": {
"all": {
"items": {
"properties": {
"metric": {
"anyOf": [
{
"enum": [
"spend",
"impressions",
"clicks",
"conversions",
"ctr",
"cpc",
"cpm",
"cpa",
"roas",
"reach",
"frequency"
]
},
{
"pattern": "^result:[a-z][a-z0-9_]{0,39}$"
}
],
"description": "`ctr` is a percentage. `spend`, `cpc`, `cpm` and `cpa` are in the ad account currency. `reach` and `frequency` use the platform's de-duplicated reach, so they are accepted on Meta and TikTok only.",
"type": "string"
},
"op": {
"enum": [
">",
">=",
"<",
"<="
],
"type": "string"
},
"value": {
"minimum": 0,
"type": "number"
},
"window": {
"description": "Days in the ad account's own timezone. `last_7d` is the 7 full days before today; only `today` reads the day in progress.",
"enum": [
"today",
"yesterday",
"last_3d",
"last_7d",
"last_14d",
"last_30d"
],
"type": "string"
}
},
"required": [
"metric",
"op",
"value",
"window"
],
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"all"
],
"type": "object"
},
"connectionId": {
"description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
},
"cooldownMinutes": {
"maximum": 43200,
"minimum": 0,
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"level": {
"description": "Whether the rule checks campaigns, ad sets or single ads. Each one is evaluated on its own.",
"enum": [
"campaign",
"adset",
"ad"
],
"type": "string"
},
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"schedule": {
"properties": {
"everyMinutes": {
"description": "How often the rule runs, in minutes.",
"enum": [
60,
180,
360,
720,
1440
],
"type": "integer"
}
},
"required": [
"everyMinutes"
],
"type": "object"
}
},
"type": "object"
}
}
},
"required": true
},
"x-aisa-status": "enabled",
"x-aisa-pricing": {
"description": "Ads operations are free. Ad spend is billed by the ad platform to the connected ad account, never by AIsa.",
"kind": "no_customer_charge"
},
"components": {
"securitySchemes": {
"bearerAuth": {
"scheme": "bearer",
"type": "http"
}
}
}
}
Cost and request rules
A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Required with the value "spend" when the request can spend money or change spend. Without it the request is refused with 409 confirmation_required, which describes what would happen; nothing is sent to the ad platform.
Available options:
spend Path Parameters
Query Parameters
The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.
Pattern:
^adc_[0-9A-Za-z]+$Body
application/json
Each type at most once, and at most one of pause, activate and adjust_budget.
Minimum array length:
1- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
Required array length:
1 - 100 elementsEvery condition must hold for an object to match. A rate with no denominator (a CPA with no conversions) never matches.
Show child attributes
Show child attributes
The ads connection (adc_...), when not sent as the connectionId query parameter.
Pattern:
^adc_[0-9A-Za-z]+$Required range:
0 <= x <= 43200Whether the rule checks campaigns, ad sets or single ads. Each one is evaluated on its own.
Available options:
campaign, adset, ad Required string length:
1 - 200Show child attributes
Show child attributes
Response
Rule updated
Show child attributes
Show child attributes