hosting

POST `/v1/sites/{siteId}/transfer/preview`

Check whether a site could be transferred to another organization.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão sites.view; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`siteId (path)`	`Uuid`	Sim	Site ID (UUIDv7).

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`target_org_id`	`Uuid`	Sim	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`	Não	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.

Resposta

Nome	Tipo	Obrigatório	O que é
`allowed`	`boolean`	Sim	Whether the transfer would be permitted right now.
`message`	`string`	Sim	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[]`	Sim	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`	Sim	—
`domain_names`	`string[]`	Sim	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`	Não	When the inherited paid term runs out. The receiver pays nothing until then.
`renewal_amount_minor`	`integer`	Não	What it renews at, in minor units of `renewal_currency`.
`renewal_currency`	`string`	Não	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`	Sim	How many of the platform's site-attached record types would move.
`staying_tables`	`integer`	Sim	How many would stay with the sender — traffic and usage evidence, tickets, abuse history, paid add-ons.

Erros que este endpoint pode retornar

401 · 403 · 404 · 429

POST /v1/sites/{siteId}/transfer/preview