syndication

PUT /v1/syndication/connections/{connectionId}

Rename a connection or replace its credential.

सबै syndication इन्डपइन्टहरू

सबै विकासकर्ता कागजातहरू

प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (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