hosting

POST /v1/sites/{siteId}/transfer

Offer this site to another organization.

所有 hosting 端点

身份验证

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

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

免费试用

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

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

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

详细信息

Creates a transfer offer the receiving organization must accept. **Nothing moves until they do** — consent is two-sided in both directions, push and pull alike (owner ruling 2026-08-14). **What the receiver inherits.** The remaining paid term travels with the site: the subscription moves as-is, same period end, same locked price, same currency, so the receiver has the paid period free and is billed normally at renewal. No money moves, no credit note, no VAT event. Renewal is in the **subscription's** currency, not the receiver's. **`include_domain`** decides whether the domain registration, its DNS zone and records, and its mail travel too. Default `true`. With `false` the site moves alone and the receiver points a domain of their own at it — the sender keeps a renewable asset, and the receiver's site is not hostage to DNS somebody else controls. `409` when this site already has an offer waiting for a reply. `422` when the guard refuses: unpaid invoices, failed payments, active dunning, unbilled page-view or bandwidth overage, an unpaid wholesale statement, a plan shared with other sites, a staff-granted plan, a busy or non-active site, a running migration or import, a scheduled deletion, or a DNS zone the receiving account already holds. **Both organizations are checked, and both are checked again at accept time** — an offer may stand for fourteen days, and an account that was clear when it was made can be in arrears when it is accepted. Requires `sites.view` **and** `sites.transfer`.

参数

名称类型必填内容简介
siteId (path)UuidSite ID (UUIDv7).

请求正文

名称类型必填内容简介
target_org_idUuidThe **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_domainbooleanWhether 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.
recipient_emailstringWhere to notify the recipient, and the record of who the sender meant to send it to. **Not** how the receiving organization is resolved — that is `target_org_id`.
messagestringA note shown to the receiver. Never interpreted.

响应

名称类型必填内容简介
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_namestringThe site's name as it was when the offer was made. Snapshotted onto the offer, not read live: while a transfer is pending the site still belongs to the sender, and reading it li…
primary_domainstringThe site's domain as it was when the offer was made. Snapshotted, as above.
directionstring<incoming, outgoing>From **this caller's** point of view. Computed per request, never stored — the same row is outgoing to one party and incoming to the other.
statusstring<pending, accepted, declined, cancelled, expired, failed>Five terminal states rather than one, because *why* an offer ended is what support is actually asked. `failed` means it was accepted and could not complete; nothing moved.
include_domainbooleanWhether the domain, its DNS and its mail travel with the site.
recipient_emailstringOnly populated for the **sender**. To the receiver it is their own address and carries no information; to anyone else it would be a third party's email address in a row two orga…
messagestring
expires_atstringAn unaccepted offer expires fourteen days after it is made.
term_ends_atstring
renewal_amount_minorinteger
renewal_currencystring
created_atstring
decided_atstring
failure_reasonstringWhy a `failed` transfer could not complete. Empty otherwise.

此端点可能返回的错误

401 · 403 · 404 · 409 · 422 · 429