ads

PATCH `/v1/ads/builds/{build_id}`

Change what they sell, the budget, the currency, the markets or the site languages before (re)building.

Authentication

Send an API key as a bearer token. The key must carry the ads.manage permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X PATCH https://api.zinndigital.com/v1/ads/builds/{build_id} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Gated on ads.manage. Refused (busy) while it is scanning, building or launched.

Parameters

Name	Type	Required	What it is
`build_id (path)`	`string`	Yes	—

Request body

Name	Type	Required	What it is
`monthly_budget_minor`	`integer`	No	—
`currency`	`string`	No	—
`markets`	`AdsBuildMarket[]`	No	—
`offer`	`string`	No	—
`languages`	`string \| AdsSiteLanguage[]`	No	za-106: confirm or override the detected site languages — Google codes, or rows with the language's own https address. `[]` = use what was detected.

Response

Name	Type	Required	What it is
`id`	`string`	Yes	—
`org_id`	`string`	Yes	—
`url`	`string`	Yes	—
`domain`	`string`	Yes	—
`monthly_budget_minor`	`integer`	Yes	—
`currency`	`string`	Yes	—
`markets`	`AdsBuildMarket[]`	Yes	—
`languages`	`AdsSiteLanguage[]`	Yes	za-106: the site languages the customer confirmed or overrode; empty = the plan uses what the scan detected (`site.languages`).
`market_languages`	`AdsMarketLanguage[]`	No	Full reads only. Per market, before any research is paid for: can it run (a language the site has and Google serves), where its ads land, and why not — `languageNotOnSite` (with…
`offer`	`string`	Yes	—
`status`	`string<scanning, scanned, building, ready, failed, launched>`	Yes	—
`error`	`object`	Yes	Empty, or `code` (and for an AI failure `message`, `failure`, `can_buy`).
`created_at`	`string`	Yes	—
`updated_at`	`object`	Yes	—
`connection_id`	`object`	Yes	—
`change_ids`	`string[]`	Yes	—
`launched_at`	`object`	Yes	—
`site`	`object`	No	What the scan read (pages, sentence count, brand, language) and, za-106, every language the site declares (`languages`, each with its address and where it was found) and the…
`prefill`	`object`	No	The AI's pre-fill (offer, brand, products, sitelinks, callouts). Full reads only.
`plan`	`object`	No	The plan (full reads only): campaigns, ads, dropped_lines, policy, competitors, forecast, assumptions, tracking, extensions, unallocated_minor.

Errors this endpoint can return

401 · 403 · 404 · 422 · 429

PATCH /v1/ads/builds/{build_id}