POST /v1/ai/site-builds/{siteBuildId}/publications

Authentication

Send an API key as a bearer token. The key must carry the hosting.deploy.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 POST https://api.zinndigital.com/v1/ai/site-builds/{siteBuildId}/publications \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "site_id": <Uuid>, "disposition": <SiteMakerDisposition> }'

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

Starts a durable publication and returns 202, not 201: the work has been accepted and is running. A 201 would say the site is published when the backup has not started, and a customer reads "created" as "done". A destination listSiteBuildTargets marks publishable: false (no repository on a WordPress or PHP fleet site, or a static site still being set up) is refused with not_publishable before any row or backup is created (s1014 L57). disposition decides what happens to whatever is already on the destination: * add_to — every existing file is kept byte-for-byte and only new paths are written. A collision is renamed (about.html becomes about-new.html), never merged and never overwritten. revamp — markup, stylesheets and scripts are replaced; content, data files and robots.txt, sitemap.xml, .htaccess and ads.txt are kept. A file type we have never seen defaults to kept. replace — the whole tree becomes the draft. Destructive. A replace requires confirm_hostname to equal the site's own primary domain, typed. A boolean flag would be satisfied by any client that set it — including a retry and every future caller that copied the previous request body — so it would confirm that a field exists rather than that a human read the domain. Anything that would overwrite live files takes a full backup first and waits for it to finish. That includes a revamp that happens to overwrite real pages: the requirement is keyed on what the publication does, not on which word was chosen. A site whose hosting cannot produce a backup is refused rather than published, because we cannot make the change reversible there. One live publication per destination at a time; a second is refused with 409. Requires hosting.deploy.manage, and the target site is scoped by that same authority.

Parameters

Request body

Response

Errors this endpoint can return

401 · 403 · 404 · 409 · 422 · 429