syndication
PUT /v1/syndication/connections/{connectionId}
Rename a connection or replace its credential.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X PUT https://api.zinndigital.com/v1/syndication/connections/{connectionId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
⛔ 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`.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
connectionId (path) | string | Evet | — |
İstek gövdesi
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
name | string | Hayır | — |
credentials | object | Hayır | ⛔ Omit to KEEP the stored credential. Sending it replaces the secret half. |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | string | Evet | — |
channel | string | Evet | — |
name | string | Evet | 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 | Evet | The non-secret half — a handle, an instance, a board id. |
status | string<unverified, ready, needs_reconnect, error> | Evet | ⛔⛔ `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 | Evet | The account the VENDOR said this credential belongs to — discovered. |
verify_error | string | Evet | A machine code the dashboard turns into copy. Never a sentence. |
verified_at | string | Evet | — |
expires_at | string | Evet | ⛔ `null` means **no stated expiry**, which is a different fact from "never expires" and must not render as an unqualified green. |
byo | boolean | Evet | Whether the customer supplied their own developer app. |
created_at | string | Evet | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404