hosting

POST `/v1/sites/{siteId}/transfer/preview`

Check whether a site could be transferred to another organization.

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 sites.view 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织，且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

curl -X POST https://api.zinndigital.com/v1/sites/{siteId}/transfer/preview \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "target_org_id": <Uuid> }'

已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。在 API 控制台中打开此端点

详细信息

Answers *"would this go through, and what would it take with it"* without writing anything. The sender's form calls this before it offers, so arrears and structural problems read as a checklist rather than as a failure after the fact. ⛔ **`POST` for a read**, deliberately: the proposal has a body (a target organization and a domain choice), and putting a UUID in a query string would leave the receiving account's id in access logs and `Referer` headers. ⛔ **The receiving account's arrears are NOT itemised to the sender.** When the target organization is what blocks the transfer, `details` carries a single `target_account` entry saying only that the receiving account has an outstanding balance its owner must settle. Itemising it would make this endpoint a way to read any organization's financial position by offering it a site. The receiver sees every number on their own accept screen, where it is their own data. Requires `sites.view` **and** `sites.transfer`. `404` for a site that is not theirs.

参数

名称	类型	必填	内容简介
`siteId (path)`	`Uuid`	是	Site ID (UUIDv7).

请求正文

名称	类型	必填	内容简介
`target_org_id`	`Uuid`	是	The receiving organization's id, which its owner gives to the sender. ⛔ An organization id rather than an email address, and that is a privacy decision. Resolving a recipien…
`include_domain`	`boolean`	否	Whether the domain registration, its DNS zone and records, and its mail travel with the site. `false` moves the site alone and the receiver points a domain of their own at it.

响应

名称	类型	必填	内容简介
`allowed`	`boolean`	是	Whether the transfer would be permitted right now.
`message`	`string`	是	The refusal in words, composed by the engine for API and staff-console readers. Empty when `allowed`. The dashboard renders its own localised sentences from `details[].field` an…
`details`	`ErrorDetail[]`	是	One entry per reason, machine-readable. `field` is the blocker code (`unpaid_invoices`, `dunning_active`, `page_view_overage`, `bandwidth_overage`, `wholesale_statement`, `faile…
`include_domain`	`boolean`	是	—
`domain_names`	`string[]`	是	The domains that would change hands. Read from the registrations we actually hold — a site on a domain registered elsewhere lists none, rather than naming a registration we cann…
`term_ends_at`	`string`	否	When the inherited paid term runs out. The receiver pays nothing until then.
`renewal_amount_minor`	`integer`	否	What it renews at, in minor units of `renewal_currency`.
`renewal_currency`	`string`	否	The subscription's currency, which does not change on transfer. A locked price is already currency-locked, and converting it would silently re-price a paid term at a rate no…
`moving_tables`	`integer`	是	How many of the platform's site-attached record types would move.
`staying_tables`	`integer`	是	How many would stay with the sender — traffic and usage evidence, tickets, abuse history, paid add-ons.

此端点可能返回的错误

401 · 403 · 404 · 429

POST /v1/sites/{siteId}/transfer/preview