syndication

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

Rename a connection or replace its credential.

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

⛔ 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

Nome	Tipo	Obrigatório	O que é
`connectionId (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`name`	`string`	Não	—
`credentials`	`object`	Não	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Resposta

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

Erros que este endpoint pode retornar

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}