syndication

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

Rename a connection or replace its credential.

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

Tên	Loại	Bắt buộc	Nội dung này là gì
`connectionId (path)`	`string`	Có	—

Nội dung yêu cầu

Tên	Loại	Bắt buộc	Nội dung này là gì
`name`	`string`	Không	—
`credentials`	`object`	Không	⛔ Omit to KEEP the stored credential. Sending it replaces the secret half.

Phản hồi

Tên	Loại	Bắt buộc	Nội dung này là gì
`id`	`string`	Có	—
`channel`	`string`	Có	—
`name`	`string`	Có	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`	Có	The non-secret half — a handle, an instance, a board id.
`status`	`string<unverified, ready, needs_reconnect, error>`	Có	⛔⛔ `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`	Có	The account the VENDOR said this credential belongs to — discovered.
`verify_error`	`string`	Có	A machine code the dashboard turns into copy. Never a sentence.
`verified_at`	`string`	Có	—
`expires_at`	`string`	Có	⛔ `null` means no stated expiry, which is a different fact from "never expires" and must not render as an unqualified green.
`byo`	`boolean`	Có	Whether the customer supplied their own developer app.
`created_at`	`string`	Có	—

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404

PUT /v1/syndication/connections/{connectionId}