syndication

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

Rename a connection or replace its credential.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Parametry

Název	Typ	Požadováno	Co to je
`connectionId (path)`	`string`	Ano	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ne	—
`credentials`	`object`	Ne	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`string`	Ano	—
`channel`	`string`	Ano	—
`name`	`string`	Ano	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`	Ano	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Ano	⛔⛔ `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`	Ano	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Ano	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Ano	—
`expires_at`	`string`	Ano	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Ano	Whether the customer supplied their own developer app.
`created_at`	`string`	Ano	—

Chyby, které může tento koncový bod vrátit

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}