認証
ベアラー トークンとして API キーを送信します。キーには sites.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
このエンドポイントは組織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) | 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. |
recipient_email | string | はい | Where 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`. |
message | string | いいえ | A note shown to the receiver. Never interpreted. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | はい | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | いいえ | The 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_domain | string | いいえ | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<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. |
status | string<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_domain | boolean | はい | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | いいえ | Only 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… |
message | string | いいえ | — |
expires_at | string | はい | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | いいえ | — |
renewal_amount_minor | integer | いいえ | — |
renewal_currency | string | いいえ | — |
created_at | string | はい | — |
decided_at | string | いいえ | — |
failure_reason | string | いいえ | Why a `failed` transfer could not complete. Empty otherwise. |
このエンドポイントが返すエラー
401 · 403 · 404 · 409 · 422 · 429