syndication

PUT `/v1/syndication/connections/{connectionId}`

Rename a connection or replace its credential.

प्रमाणन

एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।

यह एंडपॉइंट कोई संगठन आईडी नहीं लेता है। आपकी कुंजी पहले से ही उस संगठन की पहचान करती है जिससे वह संबंधित है, और प्रतिक्रिया उसी के दायरे में है।

इसे आज़माएँ

कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।

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`	हाँ	—

अनुरोध बॉडी

नाम	प्रकार	आवश्यक	यह क्या है
`name`	`string`	नहीं	—
`credentials`	`object`	नहीं	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

प्रतिक्रिया

नाम	प्रकार	आवश्यक	यह क्या है
`id`	`string`	हाँ	—
`channel`	`string`	हाँ	—
`name`	`string`	हाँ	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.
`target`	`string`	हाँ	The non-secret half — a handle, an instance, a board id.
`status`	`string<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_ref`	`string`	हाँ	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	हाँ	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	हाँ	—
`expires_at`	`string`	हाँ	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	हाँ	Whether the customer supplied their own developer app.
`created_at`	`string`	हाँ	—

त्रुटियाँ जो यह एंडपॉइंट लौटा सकता है

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}