hosting
DELETE /v1/sites/{siteId}/transfer
Withdraw this site's pending transfer offer.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/transfer \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
The sender takes the offer back. Takes no body and returns the offer, which will read `cancelled`. ⛔ **`DELETE` on the *offer*, not `POST …/cancel`** — the resource being removed is the pending offer, and giving the undo its own noun means no request body can turn a withdrawal into something else by being slightly wrong. `404` when there is no pending offer. Requires `sites.view` **and** `sites.transfer`.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
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 · 429