ads
POST /v1/ads/builds
Start a Simple-mode plan from a website, a monthly budget and markets.
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.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/ads/builds \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "url": <string>, "monthly_budget_minor": <integer>, "currency": <string>, "markets": <AdsBuildMarket[]> }'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; audit action ads.build_create. Records the inputs and starts the site scan as a Temporal workflow (status scanning -> scanned), in which the AI pre-fills offer ("what do you sell") from the site. monthly_budget_minor is integer minor units of currency (§2.8); markets are 1-8 {country: ISO 3166-1 alpha-2, language} pairs Google Ads can target. Nothing reaches Google.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
org_id | string | No | — |
url | string | Yes | — |
monthly_budget_minor | integer | Yes | — |
currency | string | Yes | — |
markets | AdsBuildMarket[] | Yes | — |
offer | string | No | — |
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