board-github
PATCH /v1/board-github/links/{linkId}
Change a connection's sync direction or the board it sits alongside.
Autentificare
Trimiteți o cheie API ca token de tip bearer. Acest punct final nu specifică o permisiune anume în specificație, așa că acordați cheii cele mai puține drepturi necesare și verificați răspunsul în loc să faceți presupuneri.
Acest endpoint nu necesită un ID de organizație. Cheia ta identifică deja organizația căreia îi aparține, iar răspunsul este limitat la aceasta.
Încearcă
Înlocuiți tot ce se află între paranteze unghiulare cu propriile valori și substituentul cheie cu o cheie din tabloul de bord.
curl -X PATCH https://api.zinndigital.com/v1/board-github/links/{linkId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Autentificat? Consola API din panoul de control îți completează ID-ul real al organizației și propria cheie și rulează cererea în API-ul live, astfel încât să poți vedea răspunsul efectiv. Deschideți acest punct final în consola API
Detalii
`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.
Parametri
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
linkId (path) | string | Da | The GitHub Projects connection. |
Corp cerere
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
direction | GitHubSyncDirection | Nu | `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 | Nu | 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 | Nu | — |
Răspuns
| Nume | Tip | Obligatoriu | Ce este |
|---|---|---|---|
id | string | Nu | — |
board_id | string | Nu | — |
auth_kind | GitHubAuthKind | Nu | `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 | Nu | 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 | Nu | Whether a token is held in Vault for this connection. The token itself is never returned. |
project_node_id | string | Nu | — |
project_number | integer | Nu | — |
owner_login | string | Nu | — |
owner_type | string | Nu | — |
title | string | Nu | — |
short_description | string | Nu | — |
closed | boolean | Nu | — |
public | boolean | Nu | — |
direction | GitHubSyncDirection | Nu | `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 | Nu | 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[] | Nu | 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 | Nu | — |
webhook_state | GitHubWebhookState | Nu | 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 | Nu | When a sync last SUCCEEDED. What the staleness alarm fires off. |
last_attempted_at | string | Nu | 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 | Nu | — |
created_at | string | Nu | — |
fields | GitHubProjectField[] | Nu | 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… |
Erori pe care le poate returna acest punct final
401 · 403 · 404 · 422