board-github
PATCH /v1/board-github/links/{linkId}
Change a connection's sync direction or the board it sits alongside.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PATCH https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-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