syndication

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

Rename a connection or replace its credential.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`connectionId (path)`	`string`	Այո	—

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`name`	`string`	Ոչ	—
`credentials`	`object`	Ոչ	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`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}