Skip to main content
PUT
Pause or resume a single ad

Request contract

  • Method and path: PUT /apis/v1/ads/{adId}/status
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/ads/{adId}/status
  • adId: path; required
  • 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

Path Parameters

adId
string
required

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
status
enum<string>
required
Available options:
active,
paused
connectionId
string

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

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

Response

Ad status updated (or skipped when no change was needed)

configuredStatus
string | null

The ad's own on/off switch (ACTIVE / PAUSED), re-read from the platform after the write. Null where the platform exposes no per-ad switch (X) or the read-back failed and the platform does not store one.

message
string

Human-readable summary (present only when skipped), e.g. "No change: the ad's own switch is already off"

skipped
integer

1 when skipped (terminal status, or the ad's own switch already in the target state), else 0

status
string

The ad's delivery status after the call, as the platform reports it when it can be read back (e.g. paused for an ad switched on under a paused campaign)

updated
integer

1 when the switch was written, 0 when skipped