syndication

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

Rename a connection or replace its credential.

Аутентификация

API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.

Бұл соңғы нүкте ұйым идентификаторын қабылдамайды. Сіздің кілтіңіз оның қай ұйымға тиесілі екенін өзі анықтайды және жауап соған шектеледі.

Әрекет етіп көру

Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.

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

Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз

Мәліметтер

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

Параметрлер

Аты	Tүрі	Міндетті	Мазмұны
`connectionId (path)`	`string`	Иә	—

Сұрау денесі

Аты	Tүрі	Міндетті	Мазмұны
`name`	`string`	Жоқ	—
`credentials`	`object`	Жоқ	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Жауап

Аты	Tүрі	Міндетті	Мазмұны
`id`	`string`	Иә	—
`channel`	`string`	Иә	—
`name`	`string`	Иә	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`	Иә	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Иә	⛔⛔ `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`	Иә	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Иә	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Иә	—
`expires_at`	`string`	Иә	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Иә	Whether the customer supplied their own developer app.
`created_at`	`string`	Иә	—

Бұл соңғы нүкте қайтара алатын қателер

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}