syndication

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

Rename a connection or replace its credential.

Tous les points de terminaison syndication

Authentification

Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.

Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.

Essayer

Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.

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

Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API

Détails

⛔ 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ètres

Nom	Type	Obligatoire	Qu'est-ce que c'est
`connectionId (path)`	`string`	Oui	—

Corps de la requête

Nom	Type	Obligatoire	Qu'est-ce que c'est
`name`	`string`	Non	—
`credentials`	`object`	Non	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Réponse

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

Erreurs que cet point de terminaison peut renvoyer

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}