syndication

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

Rename a connection or replace its credential.

Autenticación

Envía una clave de API como token de portador. Este endpoint no especifica un permiso concreto en la especificación, así que otorga a tu clave los mínimos privilegios necesarios y comprueba la respuesta en lugar de dar por sentado.

Este endpoint no requiere ningún id de organización. Su clave ya identifica la organización a la que pertenece, y la respuesta está delimitada a ella.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

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

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`connectionId (path)`	`string`	Sí	—

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`name`	`string`	No	—
`credentials`	`object`	No	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Respuesta

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

Errores que este endpoint puede devolver

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}