hosting
POST /v1/sites/{siteId}/transfer/preview
Check whether a site could be transferred to another organization.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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