board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/field
Set or clear one field value on a GitHub Project item.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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}/items/{itemId}/field \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "field_node_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
`value: null` **clears** the field, through a different GitHub mutation. Sending an empty string would set the field *to* the empty string, which a date field refuses and a text field renders as a permanent blank chip — a save that looks like it worked. Only TEXT, NUMBER, DATE, SINGLE_SELECT and ITERATION are writable; every other type is either computed by GitHub or set on the underlying issue. The `writable` flag on each field in the connection payload is computed server-side so the UI never keeps its own copy of that list.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
linkId (path) | string | Yes | The GitHub Projects connection. |
itemId (path) | string | Yes | The item, by OUR id — not GitHub's node id, which is not a path-safe value. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
field_node_id | string | Yes | — |
value | object | No | `null` CLEARS the field, through a different GitHub mutation. An empty string would set the field to the empty string. |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | No | — |
item_node_id | string | No | — |
item_type | string<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED> | No | — |
content_number | integer | No | — |
repository | string | No | — |
title | string | No | — |
body | string | No | — |
url | string | No | — |
state | string | No | — |
is_archived | boolean | No | — |
field_values | object | No | Keyed by the field's **node id**, never its name. A project owner renaming a field would otherwise orphan every stored value at once, and the next sync would read it as "every i… |
github_updated_at | string | No | — |
local_updated_at | string | No | When WE last changed this item. Set only by a local edit, never by a sync — a sync that stamped it would make every imported item look locally-edited and hand every subsequent c… |
card_id | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422