syndication

PUT /v1/syndication/connections/{connectionId}

Rename a connection or replace its credential.

تمام syndication اینڈ پوائنٹس

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X PUT https://api.zinndigital.com/v1/syndication/connections/{connectionId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

⛔ Omitting `credentials` KEEPS the stored credential rather than clearing it — a customer renaming a connection must not silently delete their token. Gated on `syndication.manage`.

پیرامیٹرز

نامقسملازمییہ کیا ہے
connectionId (path)stringہاں

درخواست کا باڈی

نامقسملازمییہ کیا ہے
namestringنہیں
credentialsobjectنہیں⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

جواب

نامقسملازمییہ کیا ہے
idstringہاں
channelstringہاں
namestringہاںThe customer's own name for it. ⛔ `name` on the wire, `label` on the model: `Field.label` is DRF's own attribute and shadowing it is silent at runtime.
targetstringہاںThe non-secret half — a handle, an instance, a board id.
statusstring<unverified, ready, needs_reconnect, error>ہاں⛔⛔ `needs_reconnect` is NOT a failure — the credential lapsed and only the customer can fix it. `unverified` means we have not looked, which is a third fact and not a quiet green.
account_refstringہاںThe account the VENDOR said this credential belongs to — discovered.
verify_errorstringہاںA machine code the dashboard turns into copy. Never a sentence.
verified_atstringہاں
expires_atstringہاں⛔ `null` means **no stated expiry**, which is a different fact from "never expires" and must not render as an unqualified green.
byobooleanہاںWhether the customer supplied their own developer app.
created_atstringہاں

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404