platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
Authentication
Send an API key as a bearer token. The key must carry the billing.view permission; a key without it is refused with 403, not 404.
Where your organisation id goes
This endpoint takes org_id as a field in the JSON body.
Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
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> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
source_platform | string | Yes | — |
target_platform | string | Yes | — |
source_url | string | Yes | — |
entity_count | integer | Yes | — |
target_site_id | object | No | 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 | No | — |
org_id | object | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Yes | — |
source_platform_name | string | No | — |
target_platform | string | Yes | — |
target_platform_name | string | No | — |
source_url | string | Yes | — |
target_site_id | object | No | — |
tier_code | string | Yes | — |
tier_name | string | No | — |
entity_count_estimate | integer | No | — |
status | PlatformTransferStatus | Yes | — |
status_label | string | No | — |
price_amount_minor | integer | Yes | — |
price_currency | string | Yes | — |
redirects_mapped | boolean | No | — |
redirect_count | integer | No | — |
canonicals_verified | boolean | No | — |
sitemap_submitted | boolean | No | — |
structured_data_preserved | boolean | No | — |
seo_checks_complete | boolean | No | — |
customer_note | string | No | — |
sla_due_at | object | No | — |
created_at | string | Yes | — |
completed_at | object | No | — |
events | PlatformTransferEvent[] | No | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429