Skip to main content
PATCH
Update ad account settings

Request contract

  • Method and path: PATCH /apis/v1/ads/accounts
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/ads/accounts
  • connectionId: query; required
  • X-Aisa-Confirm: header; optional
  • Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Aisa-Confirm
enum<string>

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

connectionId
string
required

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
adAccountId
string
required

Meta ad account ID (act_...)

connectionId
string

The ads connection (adc_...), when not sent as the connectionId query parameter.

Pattern: ^adc_[0-9A-Za-z]+$
defaultDsaBeneficiary
string

Legal entity benefiting from ads on this ad account

Maximum string length: 100
defaultDsaPayor
string

Legal entity paying for ads on this ad account. Defaults to defaultDsaBeneficiary when omitted. Requires defaultDsaBeneficiary.

Maximum string length: 100
finalUrlSuffix
string

Google only. Account final URL suffix (customer.final_url_suffix); an empty string clears it.

name
string

New ad account name.

Maximum string length: 255
resetAmountSpent
boolean

Restart the amount counted against the cap from zero. Cannot be combined with spendCap null.

spendCap
number | null

Account spend cap in whole currency units; null removes it.

trackingUrlTemplate
string

Google only. Account tracking template (customer.tracking_url_template); an empty string clears it.

Response

Settings updated (each block re-read from Meta after the write)

adAccountId
string
dsaDefaults
object

Present when defaultDsaBeneficiary was passed.

settings
object

Present when name, spendCap or resetAmountSpent was passed.

urlTracking
object

Google only. The URL tracking fields written.