syndication

PUT /v1/syndication/connections/{connectionId}

Rename a connection or replace its credential.

Toate punctele finale syndication

Autentificare

Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.

Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.

Încearcă

Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.

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

Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API

Detalii

⛔ 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`.

Parametri

NumeTipObligatoriuCe este
connectionId (path)stringDa

Corp cerere

NumeTipObligatoriuCe este
namestringNu
credentialsobjectNu⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Răspuns

NumeTipObligatoriuCe este
idstringDa
channelstringDa
namestringDaThe 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.
targetstringDaThe non-secret half — a handle, an instance, a board id.
statusstring<unverified, ready, needs_reconnect, error>Da⛔⛔ `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_refstringDaThe account the VENDOR said this credential belongs to — discovered.
verify_errorstringDaA machine code the dashboard turns into copy. Never a sentence.
verified_atstringDa
expires_atstringDa⛔ `null` means **no stated expiry**, which is a different fact from "never expires" and must not render as an unqualified green.
byobooleanDaWhether the customer supplied their own developer app.
created_atstringDa

Erori pe care le poate returna acest punct final

401 · 403 · 404