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.

פרמטרים

שם	סוג	נדרש	מה זה
`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}