platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão billing.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como um campo no corpo JSON.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
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/platform-transfers \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "source_platform": <string>, "target_platform": <string>, "source_url": <string>, "entity_count": <integer> }'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
Creates the request in `draft`. **No money moves here** — call `payPlatformTransfer` to charge it. The row is written before the charge on purpose: a declined card then leaves a visible `payment_failed` transfer rather than a charge for a job nobody can see. Requires `billing.view`.
Corpo da requisição
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
source_platform | string | Sim | — |
target_platform | string | Sim | — |
source_url | string | Sim | — |
entity_count | integer | Sim | — |
target_site_id | object | Não | Where it lands. May be omitted — a customer often buys the transfer before the destination site exists, which is the point of an on-ramp. |
customer_note | string | Não | — |
org_id | object | Não | — |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Sim | — |
source_platform_name | string | Não | — |
target_platform | string | Sim | — |
target_platform_name | string | Não | — |
source_url | string | Sim | — |
target_site_id | object | Não | — |
tier_code | string | Sim | — |
tier_name | string | Não | — |
entity_count_estimate | integer | Não | — |
status | PlatformTransferStatus | Sim | — |
status_label | string | Não | — |
price_amount_minor | integer | Sim | — |
price_currency | string | Sim | — |
redirects_mapped | boolean | Não | — |
redirect_count | integer | Não | — |
canonicals_verified | boolean | Não | — |
sitemap_submitted | boolean | Não | — |
structured_data_preserved | boolean | Não | — |
seo_checks_complete | boolean | Não | — |
customer_note | string | Não | — |
sla_due_at | object | Não | — |
created_at | string | Sim | — |
completed_at | object | Não | — |
events | PlatformTransferEvent[] | Não | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422 · 429