platform-transfers
POST /v1/platform-transfers
Book a platform transfer (nothing is charged yet).
प्रमाणन
बेरर टोकन के रूप में एक API कुंजी भेजें। कुंजी के पास billing.view अनुमति होनी चाहिए; इसके बिना एक कुंजी को 404 के बजाय 403 के साथ अस्वीकार कर दिया जाता है।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट JSON बॉडी में एक फ़ील्ड के रूप में org_id लेता है।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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> }'साइन इन हैं? आपके डैशबोर्ड में मौजूद API कंसोल आपकी वास्तविक संगठन आईडी और आपकी अपनी कुंजी स्वतः भर देता है, और लाइव API के विरुद्ध अनुरोध चलाता है ताकि आप वास्तविक प्रतिक्रिया देख सकें। इस एंडपॉइंट को API कंसोल में खोलें
विवरण
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`.
अनुरोध बॉडी
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
source_platform | string | हाँ | — |
target_platform | string | हाँ | — |
source_url | string | हाँ | — |
entity_count | integer | हाँ | — |
target_site_id | object | नहीं | 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 | नहीं | — |
org_id | object | नहीं | — |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यह क्या है |
|---|---|---|---|
id | Uuid | हाँ | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
source_platform | string | हाँ | — |
source_platform_name | string | नहीं | — |
target_platform | string | हाँ | — |
target_platform_name | string | नहीं | — |
source_url | string | हाँ | — |
target_site_id | object | नहीं | — |
tier_code | string | हाँ | — |
tier_name | string | नहीं | — |
entity_count_estimate | integer | नहीं | — |
status | PlatformTransferStatus | हाँ | — |
status_label | string | नहीं | — |
price_amount_minor | integer | हाँ | — |
price_currency | string | हाँ | — |
redirects_mapped | boolean | नहीं | — |
redirect_count | integer | नहीं | — |
canonicals_verified | boolean | नहीं | — |
sitemap_submitted | boolean | नहीं | — |
structured_data_preserved | boolean | नहीं | — |
seo_checks_complete | boolean | नहीं | — |
customer_note | string | नहीं | — |
sla_due_at | object | नहीं | — |
created_at | string | हाँ | — |
completed_at | object | नहीं | — |
events | PlatformTransferEvent[] | नहीं | The customer-visible trail only. Staff notes name vendors and what a job cost us, and never appear here. |
त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है
401 · 403 · 404 · 422 · 429