Update a conversion action's settings
curl --request PATCH \
--url https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectionId": "adc_7f3k2m9q",
"name": "Winter launch",
"status": "ENABLED"
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}"
payload = {
"connectionId": "adc_7f3k2m9q",
"name": "Winter launch",
"status": "ENABLED"
}
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({connectionId: 'adc_7f3k2m9q', name: 'Winter launch', status: 'ENABLED'})
};
fetch('https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}', 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/conversions/actions/{actionId}",
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([
'connectionId' => 'adc_7f3k2m9q',
'name' => 'Winter launch',
'status' => 'ENABLED'
]),
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/conversions/actions/{actionId}"
payload := strings.NewReader("{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}")
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/conversions/actions/{actionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}")
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 = "{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}"
response = http.request(request)
puts response.read_body{
"action": {
"alwaysUseDefaultValue": true,
"category": "<string>",
"clickThroughLookbackWindowDays": 123,
"countingType": "<string>",
"defaultCurrency": "<string>",
"defaultValue": 123,
"id": "<string>",
"name": "<string>",
"primaryForGoal": true,
"status": "<string>",
"viewThroughLookbackWindowDays": 123
},
"customerId": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}AIsa Ads
Update a conversion action's settings
Conversions. Changes the ad account without starting or raising spend; audited. Changes a Google Ads conversion action's settings, such as primary or secondary, counting, value and lookback windows, or removes or restores it. Updates a Google Ads conversion action in one mutate, each field sent written on its own update mask leaf so omitted fields keep their value. Send at least one field.
<!-- 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
/
conversions
/
actions
/
{actionId}
Update a conversion action's settings
curl --request PATCH \
--url https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"connectionId": "adc_7f3k2m9q",
"name": "Winter launch",
"status": "ENABLED"
}
'import requests
url = "https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}"
payload = {
"connectionId": "adc_7f3k2m9q",
"name": "Winter launch",
"status": "ENABLED"
}
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({connectionId: 'adc_7f3k2m9q', name: 'Winter launch', status: 'ENABLED'})
};
fetch('https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}', 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/conversions/actions/{actionId}",
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([
'connectionId' => 'adc_7f3k2m9q',
'name' => 'Winter launch',
'status' => 'ENABLED'
]),
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/conversions/actions/{actionId}"
payload := strings.NewReader("{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}")
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/conversions/actions/{actionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId}")
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 = "{\n \"connectionId\": \"adc_7f3k2m9q\",\n \"name\": \"Winter launch\",\n \"status\": \"ENABLED\"\n}"
response = http.request(request)
puts response.read_body{
"action": {
"alwaysUseDefaultValue": true,
"category": "<string>",
"clickThroughLookbackWindowDays": 123,
"countingType": "<string>",
"defaultCurrency": "<string>",
"defaultValue": 123,
"id": "<string>",
"name": "<string>",
"primaryForGoal": true,
"status": "<string>",
"viewThroughLookbackWindowDays": 123
},
"customerId": "<string>"
}{
"error": {
"code": "<string>",
"details": {},
"message": "<string>",
"param": "<string>",
"retryHint": "<string>",
"retryable": true,
"type": "<string>"
}
}Request contract
- Method and path: PATCH /apis/v1/ads/conversions/actions/{actionId}
- Availability: enabled
- Request URL template:
https://api.aisa.one/apis/v1/ads/conversions/actions/{actionId} - actionId: path; required
- connectionId: query; required
- Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
{
"operationId": "patch_aisa_ads_apis_v1_ads_conversions_actions_actionid",
"method": "PATCH",
"path": "/apis/v1/ads/conversions/actions/{actionId}",
"servers": [
{
"url": "https://api.aisa.one"
}
],
"parameters": [
{
"description": "Google conversion action id",
"in": "path",
"name": "actionId",
"required": true,
"schema": {
"pattern": "^\\d+$",
"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"
}
}
],
"security": [
{
"bearerAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"connectionId": "adc_7f3k2m9q",
"name": "Winter launch",
"status": "ENABLED"
},
"schema": {
"additionalProperties": false,
"properties": {
"adAccountId": {
"description": "Google customer id. Required when the connection has multiple customers.",
"pattern": "^\\d+$",
"type": "string"
},
"alwaysUseDefaultValue": {
"type": "boolean"
},
"category": {
"description": "conversion_action.category. Defaults to DEFAULT on create.",
"enum": [
"DEFAULT",
"PAGE_VIEW",
"PURCHASE",
"SIGNUP",
"DOWNLOAD",
"ADD_TO_CART",
"BEGIN_CHECKOUT",
"SUBSCRIBE_PAID",
"PHONE_CALL_LEAD",
"IMPORTED_LEAD",
"SUBMIT_LEAD_FORM",
"BOOK_APPOINTMENT",
"REQUEST_QUOTE",
"GET_DIRECTIONS",
"OUTBOUND_CLICK",
"CONTACT",
"ENGAGEMENT",
"STORE_VISIT",
"STORE_SALE",
"QUALIFIED_LEAD",
"CONVERTED_LEAD"
],
"type": "string"
},
"clickThroughLookbackWindowDays": {
"description": "Days after an ad click a conversion still counts.",
"maximum": 90,
"minimum": 1,
"type": "integer"
},
"connectionId": {
"description": "The ads connection (adc_...), when not sent as the connectionId query parameter.",
"pattern": "^adc_[0-9A-Za-z]+$",
"type": "string"
},
"countingType": {
"description": "ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).",
"enum": [
"ONE_PER_CLICK",
"MANY_PER_CLICK"
],
"type": "string"
},
"customerId": {
"description": "Alias of adAccountId",
"pattern": "^\\d+$",
"type": "string"
},
"defaultCurrency": {
"description": "ISO 4217 currency of defaultValue (value_settings.default_currency_code).",
"pattern": "^[A-Z]{3}$",
"type": "string"
},
"defaultValue": {
"minimum": 0,
"type": "number"
},
"name": {
"maxLength": 100,
"minLength": 1,
"type": "string"
},
"primaryForGoal": {
"description": "true = primary (counts toward bidding when its goal is biddable), false = secondary.",
"type": "boolean"
},
"status": {
"description": "REMOVED removes the action and must be sent alone; ENABLED restores a removed one.",
"enum": [
"ENABLED",
"REMOVED"
],
"type": "string"
},
"viewThroughLookbackWindowDays": {
"description": "Days after an ad view a view-through conversion still counts.",
"maximum": 30,
"minimum": 1,
"type": "integer"
}
},
"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.
Path Parameters
Google conversion action id
Pattern:
^\d+$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
Google customer id. Required when the connection has multiple customers.
Pattern:
^\d+$conversion_action.category. Defaults to DEFAULT on create.
Available options:
DEFAULT, PAGE_VIEW, PURCHASE, SIGNUP, DOWNLOAD, ADD_TO_CART, BEGIN_CHECKOUT, SUBSCRIBE_PAID, PHONE_CALL_LEAD, IMPORTED_LEAD, SUBMIT_LEAD_FORM, BOOK_APPOINTMENT, REQUEST_QUOTE, GET_DIRECTIONS, OUTBOUND_CLICK, CONTACT, ENGAGEMENT, STORE_VISIT, STORE_SALE, QUALIFIED_LEAD, CONVERTED_LEAD Days after an ad click a conversion still counts.
Required range:
1 <= x <= 90The ads connection (adc_...), when not sent as the connectionId query parameter.
Pattern:
^adc_[0-9A-Za-z]+$ONE_PER_CLICK counts one conversion per ad click (leads); MANY_PER_CLICK counts every one (purchases).
Available options:
ONE_PER_CLICK, MANY_PER_CLICK Alias of adAccountId
Pattern:
^\d+$ISO 4217 currency of defaultValue (value_settings.default_currency_code).
Pattern:
^[A-Z]{3}$Required range:
x >= 0Required string length:
1 - 100true = primary (counts toward bidding when its goal is biddable), false = secondary.
REMOVED removes the action and must be sent alone; ENABLED restores a removed one.
Available options:
ENABLED, REMOVED Days after an ad view a view-through conversion still counts.
Required range:
1 <= x <= 30