syndication

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

Rename a connection or replace its credential.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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}