hosting
DELETE /v1/sites/{siteId}/transfer
Withdraw this site's pending transfer offer.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Dit eindpunt vereist geen organisatie-id. Uw sleutel identificeert al de organisatie waartoe deze behoort, en het antwoord is hierop afgestemd.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X DELETE https://api.zinndigital.com/v1/sites/{siteId}/transfer \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
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`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
siteId (path) | Uuid | Ja | Site ID (UUIDv7). |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
site_name | string | Nee | 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 | Nee | The site's domain as it was when the offer was made. Snapshotted, as above. |
direction | string<incoming, outgoing> | Ja | 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> | Ja | 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 | Ja | Whether the domain, its DNS and its mail travel with the site. |
recipient_email | string | Nee | 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 | Nee | — |
expires_at | string | Ja | An unaccepted offer expires fourteen days after it is made. |
term_ends_at | string | Nee | — |
renewal_amount_minor | integer | Nee | — |
renewal_currency | string | Nee | — |
created_at | string | Ja | — |
decided_at | string | Nee | — |
failure_reason | string | Nee | Why a `failed` transfer could not complete. Empty otherwise. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 409 · 429