Schedule a budget increase
curl --request POST \
--url https://api.aisa.one/apis/v1/ads/high-demand-periods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"budgetValue": 10,
"budgetValueType": "ABSOLUTE",
"timeEnd": 10,
"timeStart": 10
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/high-demand-periods"
payload = {
"budgetValue": 10,
"budgetValueType": "ABSOLUTE",
"timeEnd": 10,
"timeStart": 10
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({budgetValue: 10, budgetValueType: 'ABSOLUTE', timeEnd: 10, timeStart: 10})
};
fetch('https://api.aisa.one/apis/v1/ads/high-demand-periods', 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/high-demand-periods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'budgetValue' => 10,
'budgetValueType' => 'ABSOLUTE',
'timeEnd' => 10,
'timeStart' => 10
]),
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/high-demand-periods"
payload := strings.NewReader("{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.aisa.one/apis/v1/ads/high-demand-periods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/high-demand-periods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"objectId": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
Schedule a budget increase
Ad Accounts. 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. Schedules a budget increase for a period. Schedules a temporary budget increase on a Meta campaign or ad set for a busy period, like Black Friday or a launch. Same target rule as the GET: exactly one of `campaignId` / `adSetId`. ### Meta constraints `timeStart` / `timeEnd` must fall on a 15-minute boundary. A campaign cannot mix `ABSOLUTE` and `MULTIPLIER` across its schedules.
<!-- 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 -->
POST
https://api.aisa.one
/
apis
/
v1
/
ads
/
high-demand-periods
Schedule a budget increase
curl --request POST \
--url https://api.aisa.one/apis/v1/ads/high-demand-periods \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"budgetValue": 10,
"budgetValueType": "ABSOLUTE",
"timeEnd": 10,
"timeStart": 10
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/high-demand-periods"
payload = {
"budgetValue": 10,
"budgetValueType": "ABSOLUTE",
"timeEnd": 10,
"timeStart": 10
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({budgetValue: 10, budgetValueType: 'ABSOLUTE', timeEnd: 10, timeStart: 10})
};
fetch('https://api.aisa.one/apis/v1/ads/high-demand-periods', 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/high-demand-periods",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'budgetValue' => 10,
'budgetValueType' => 'ABSOLUTE',
'timeEnd' => 10,
'timeStart' => 10
]),
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/high-demand-periods"
payload := strings.NewReader("{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.aisa.one/apis/v1/ads/high-demand-periods")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/high-demand-periods")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"budgetValue\": 10,\n \"budgetValueType\": \"ABSOLUTE\",\n \"timeEnd\": 10,\n \"timeStart\": 10\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"objectId": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: POST /apis/v1/ads/high-demand-periods
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/high-demand-periods - connectionId: query; required
- X-Aisa-Confirm: header; optional
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "post_aisa_ads_apis_v1_ads_high_demand_periods",
"method": "POST",
"path": "/apis/v1/ads/high-demand-periods",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"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": {
"budgetValue": 10,
"budgetValueType": "ABSOLUTE",
"connectionId": "adc_7f3k2m9q",
"timeEnd": 10,
"timeStart": 10
},
"schema": {
"additionalProperties": true,
"properties": {
"adSetId": {
"description": "Platform ad set id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"type": "string"
},
"budgetValue": {
"description": "With ABSOLUTE, a budget in the ad account's currency in WHOLE units (50 = $50.00). With MULTIPLIER, a factor of the existing budget (2 = double it) and NOT a currency amount.",
"type": "number"
},
"budgetValueType": {
"enum": [
"ABSOLUTE",
"MULTIPLIER"
],
"type": "string"
},
"campaignId": {
"description": "Platform campaign id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.",
"type": "string"
},
"connectionId": {
"description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
},
"currency": {
"description": "Ad account currency, for the ABSOLUTE minor-unit conversion. Ignored for MULTIPLIER.",
"type": "string"
},
"recurrenceType": {
"enum": [
"ONE_TIME",
"WEEKLY",
"MONTHLY"
],
"type": "string"
},
"timeEnd": {
"description": "Unix seconds, on a 15-minute boundary and after timeStart.",
"type": "integer"
},
"timeStart": {
"description": "Unix seconds, on a 15-minute boundary (:00, :15, :30, :45).",
"type": "integer"
}
},
"required": [
"budgetValue",
"budgetValueType",
"timeEnd",
"timeStart"
],
"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 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
With ABSOLUTE, a budget in the ad account's currency in WHOLE units (50 = $50.00). With MULTIPLIER, a factor of the existing budget (2 = double it) and NOT a currency amount.
Available options:
ABSOLUTE, MULTIPLIER Unix seconds, on a 15-minute boundary and after timeStart.
Unix seconds, on a 15-minute boundary (:00, :15, :30, :45).
Platform ad set id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
Platform campaign id. Exactly one of campaignId / adSetId. Must be yours: it is checked through the connection before the request is sent, and an id that is not yours answers not_found.
The ads connection (adc_...), when not sent as the connectionId query parameter.
Pattern:
^adc_[0-9A-Za-z]+$Ad account currency, for the ABSOLUTE minor-unit conversion. Ignored for MULTIPLIER.
Available options:
ONE_TIME, WEEKLY, MONTHLY