hosting
POST /v1/sites/{siteId}/transfer/preview
Check whether a site could be transferred to another organization.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
이 엔드포인트는 조직 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