platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
Authentifizierung
Senden Sie einen API-Schlüssel als Bearer-Token. Der Schlüssel muss über die Berechtigung billing.view verfügen; ein Schlüssel ohne diese wird mit 403 statt 404 abgelehnt.
Hier kommt Ihre Organisations-ID hin
Dieser Endpunkt akzeptiert org_id als Feld im JSON-Body.
Die ID Ihrer Organisation finden Sie im Dashboard auf dem Bildschirm für API-Schlüssel direkt neben dem Schlüssel selbst. Sie ist bei jedem Ihrer Aufrufe dieselbe.
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/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> }'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 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`.
Anfragekörper
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
source_platform | string | Ja | — |
target_platform | string | Ja | — |
source_url | string | Ja | — |
entity_count | integer | Ja | — |
target_site_id | object | Nein | 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 | Nein | — |
org_id | object | Nein | — |
Antwort
| Name | Typ | Erforderlich | Was es ist |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | Ja | — |
source_platform_name | string | Nein | — |
target_platform | string | Ja | — |
target_platform_name | string | Nein | — |
source_url | string | Ja | — |
target_site_id | object | Nein | — |
tier_code | string | Ja | — |
tier_name | string | Nein | — |
entity_count_estimate | integer | Nein | — |
status | PlatformTransferStatus | Ja | — |
status_label | string | Nein | — |
price_amount_minor | integer | Ja | — |
price_currency | string | Ja | — |
redirects_mapped | boolean | Nein | — |
redirect_count | integer | Nein | — |
canonicals_verified | boolean | Nein | — |
sitemap_submitted | boolean | Nein | — |
structured_data_preserved | boolean | Nein | — |
seo_checks_complete | boolean | Nein | — |
customer_note | string | Nein | — |
sla_due_at | object | Nein | — |
created_at | string | Ja | — |
completed_at | object | Nein | — |
events | PlatformTransferEvent[] | Nein | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
Fehler, die dieser Endpunkt zurückgeben kann
401 · 403 · 404 · 422 · 429