board-github
PUT /v1/board-github/links/{linkId}/fields/{fieldId}/wip
Set an advisory WIP limit on one status option.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/board-github/links/{linkId}/fields/{fieldId}/wip \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "option_id": <string> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
GitHub has no WIP limit feature at all, so this is new capability rather than a nicer rendering of theirs. It writes nothing to GitHub and cannot fail because of them. Advisory, exactly as a board column's limit is: a limit that refused a move would turn a management convention into an outage at 17:55 on a Friday — and here it would be refusing a write into somebody else's GitHub. limit: null clears it.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
linkId (path) | string | Yes | The GitHub Projects connection. |
fieldId (path) | string | Yes | The project field, by OUR id. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
option_id | string | Yes | — |
limit | integer | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | No | — |
field_node_id | string | No | — |
name | string | No | — |
data_type | GitHubProjectFieldType | No | Every field type Projects v2 exposes, spelled as GitHub spells it. The full set, not the four that are easy: a board that rendered TEXT/NUMBER/DATE/SELECT and silently dropped… |
position | integer | No | — |
options | object[] | No | The select's options, or the iteration's sprints. Completed iterations are kept and marked rather than dropped — a sprint board whose finished sprints vanish cannot show a… |
wip_limits | object | No | Advisory cap per single-select option, keyed by option id. Ours, not GitHub's. |
writable | boolean | No | Computed server-side from the type, so the UI never keeps its own copy of which types GitHub will accept. Two lists would drift, and the drift shows up as an editable control… |
Errors this endpoint can return
401 · 403 · 404 · 422