board-github

PATCH `/v1/board-github/links/{linkId}`

Change a connection's sync direction or the board it sits alongside.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

curl -X PATCH https://api.zinndigital.com/v1/board-github/links/{linkId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API

التفاصيل

`direction` moves a connection between two-way and read-only. A new connection is two-way immediately; read-only exists for a customer who wants a mirror they cannot break, and it is the honest remedy when GitHub keeps refusing our writes — turning writes off is better than a screen that accepts edits which never arrive.

المعلمات

الاسم	النوع	مطلوب	ما هو هذا
`linkId (path)`	`string`	نعم	The GitHub Projects connection.

جسم الطلب

الاسم	النوع	مطلوب	ما هو هذا
`direction`	`GitHubSyncDirection`	لا	`both` is the default (owner ruling, 2026-09-03: a new connection is read-write immediately). `pull` is the honest remedy when a push keeps being refused.
`notice_delivery`	`GitHubNoticeDelivery`	لا	Where a connection's overdue / gone-quiet / over-WIP notices are allowed to go. Both values raise the same notices and both render them on the board — the difference is delivery…
`board_id`	`string`	لا	—

الاستجابة

الاسم	النوع	مطلوب	ما هو هذا
`id`	`string`	لا	—
`board_id`	`string`	لا	—
`auth_kind`	`GitHubAuthKind`	لا	`app` is the Zinn® GitHub App installation — per-repository scope the customer chooses on GitHub's own screen, revocable by them in one click, belonging to their organisation ra…
`installation_id`	`string`	لا	Public — it appears in the customer's own install URL — and showing it is what lets them confirm on GitHub that they are looking at the right installation.
`has_stored_token`	`boolean`	لا	Whether a token is held in Vault for this connection. The token itself is never returned.
`project_node_id`	`string`	لا	—
`project_number`	`integer`	لا	—
`owner_login`	`string`	لا	—
`owner_type`	`string`	لا	—
`title`	`string`	لا	—
`short_description`	`string`	لا	—
`closed`	`boolean`	لا	—
`public`	`boolean`	لا	—
`direction`	`GitHubSyncDirection`	لا	`both` is the default (owner ruling, 2026-09-03: a new connection is read-write immediately). `pull` is the honest remedy when a push keeps being refused.
`notice_delivery`	`GitHubNoticeDelivery`	لا	Where a connection's overdue / gone-quiet / over-WIP notices are allowed to go. Both values raise the same notices and both render them on the board — the difference is delivery…
`views`	`object[]`	لا	The project's saved views on GitHub, replaced whole on every read so a view deleted there disappears here rather than lingering as a link GitHub answers with a 404. Rendered as…
`url`	`string`	لا	—
`webhook_state`	`GitHubWebhookState`	لا	Whether GitHub pushes changes at us, and if not, whose move it is. Three outcomes and not a boolean. `automatic` — we created the organisation webhook. `manual` — GitHub wou…
`last_synced_at`	`string`	لا	When a sync last SUCCEEDED. What the staleness alarm fires off.
`last_attempted_at`	`string`	لا	When a sync was last ATTEMPTED, stamped for every connection the sweep reaches before the result is read. Two columns rather than one: a cursor only a successful pass advanced w…
`last_error`	`string`	لا	—
`created_at`	`string`	لا	—
`fields`	`GitHubProjectField[]`	لا	The project's fields, with their single-select options and any work-in-progress limits set on them. Returned with the connection rather than fetched separately, because a board…

الأخطاء التي يمكن أن تُرجعها نقطة النهاية هذه

401 · 403 · 404 · 422

PATCH /v1/board-github/links/{linkId}