POST /v1/partner/customers/{externalId}/site-moves

Authentication

Send an API key as a bearer token. The key must carry the partner.domains 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/partner/customers/{externalId}/site-moves \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "subscription_id": <string>, "domain": <string>, "app": <string>, "archive_url": <string>, "archive_sha256": <string> }'

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 an asynchronous move of ONE site into the customer's hosting plan (docs/808 §12). Nothing is charged: the move spends a site slot the customer already pays for. The call is validated and answered at once (202); the work runs as a durable workflow and is read back with getPartnerSiteMove. The archive. archive_url is an https link our hosting box downloads directly (never through this API): a .tar.gz (or .zip) holding the document root under www/ and, for a site with a database, a MySQL dump named dump.sql at the top level — the V1 backup layout. The link must answer without cookies and must survive a HEAD plus up to three GETs (a retried download fetches again). archive_sha256 is checked on the box before anything is applied; a mismatch fails the move with archive_checksum_mismatch without touching the site. The site. It is created in the customer's organization on the plan named by subscription_id, on domain, with app (a key from getPartnerCapabilities site_moves.plans[].apps). Or pass replace_site_id — one of listPartnerHostingSlots replaceable_sites — to import into that empty site and move it onto domain instead of taking a new slot. domain may be the replaced site's own name (an empty_starter is built on the customer's real domain); that is not domain_in_use. A replaced empty_starter that has content on it when the move starts fails with replace_site_not_empty, and nothing on it is touched. The domain's DNS is never touched: it keeps pointing where it points until you repoint it, and it may stay in your (or your customer's) Cloudflare for good. A subdomain whose apex is somebody else's live site is fine. Refusals (422, details[0].code): no_free_slot, subscription_not_found, app_not_supported_by_plan, plan_cannot_import, domain_invalid, domain_in_use, archive_url_invalid, archive_checksum_invalid, replace_site_not_replaceable, move_already_running, idempotency_key_required, moves_not_open, no_capacity, dns_invalid, not_linked. There is no size limit (D28455): room is made for a large archive, and the move is slower, never refused. DNS (contract v2). dns says where the zone is held and who changes it: with auto_switch: true YOU repoint the record when the move reaches step: ready_to_switch (then call go-live); otherwise the customer is shown and e-mailed the exact records, the change is detected automatically, and the move goes live on its own. A retry with the same Idempotency-Key returns the same move. Requires partner.domains.

Parameters

Request body

Response

Errors this endpoint can return

401 · 403 · 404 · 422 · 429