hosting

POST /v1/sites/{siteId}/transfer

Offer this site to another organization.

Alle hosting Endpunkte

Authentifizierung

Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung sites.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.

Dieser Endpunkt erfordert keine Organisations-ID. Ihr Schlüssel identifiziert bereits die zugehörige Organisation, und die Antwort ist entsprechend eingeschränkt.

Ausprobieren

Ersetzen Sie alles in spitzen Klammern durch Ihre eigenen Werte und den Platzhalter für den Schlüssel durch einen Schlüssel aus Ihrem Dashboard.

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> }'

Angemeldet? Die API-Konsole in Ihrem Dashboard trägt automatisch Ihre echte Organisations-ID sowie Ihren eigenen Schlüssel ein und führt die Anfrage gegen die Live-API aus, sodass Sie die tatsächliche Antwort sehen können. Öffnen Sie diesen Endpunkt in der API-Konsole

Details

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`.

Parameter

NameTypErforderlichWas es ist
siteId (path)UuidJaSite ID (UUIDv7).

Anfragekörper

NameTypErforderlichWas es ist
target_org_idUuidJaThe **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_domainbooleanNeinWhether 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_emailstringJaWhere 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`.
messagestringNeinA note shown to the receiver. Never interpreted.

Antwort

NameTypErforderlichWas es ist
idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_idUuidJaUUIDv7 identifier — sortable by creation time (docs/02 §8).
site_namestringNeinThe 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_domainstringNeinThe site's domain as it was when the offer was made. Snapshotted, as above.
directionstring<incoming, outgoing>JaFrom **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>JaFive 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_domainbooleanJaWhether the domain, its DNS and its mail travel with the site.
recipient_emailstringNeinOnly 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…
messagestringNein
expires_atstringJaAn unaccepted offer expires fourteen days after it is made.
term_ends_atstringNein
renewal_amount_minorintegerNein
renewal_currencystringNein
created_atstringJa
decided_atstringNein
failure_reasonstringNeinWhy a `failed` transfer could not complete. Empty otherwise.

Fehler, die dieser Endpunkt zurückgeben kann

401 · 403 · 404 · 409 · 422 · 429