syndication

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

Rename a connection or replace its credential.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

Név	Típus	Kötelező	Mi ez
`connectionId (path)`	`string`	Igen	—

Kérés törzse

Név	Típus	Kötelező	Mi ez
`name`	`string`	Nem	—
`credentials`	`object`	Nem	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`string`	Igen	—
`channel`	`string`	Igen	—
`name`	`string`	Igen	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`	Igen	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Igen	⛔⛔ `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`	Igen	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Igen	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Igen	—
`expires_at`	`string`	Igen	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Igen	Whether the customer supplied their own developer app.
`created_at`	`string`	Igen	—

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}