board-github
PUT /v1/board-github/links/{linkId}/items/{itemId}/archive
Archive a GitHub Project item, or restore it.
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}/items/{itemId}/archive \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "archived": <boolean> }'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
The reversible half of clearing a board, and how a person empties a Done column without destroying anything. archived is required and carries both directions; there is no default, because a default would make a request that lost its body in a proxy mean archive — the opposite of a restore, applied silently. isArchived in the response is read back from GitHub with a second query rather than taken from the mutation's own echo, which returns the item it was handed and would therefore agree with us whether or not GitHub applied anything.
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 |
|---|---|---|---|
archived | boolean | Yes | Required, with no default. A default would make a request that lost its body mean archive, so a restore would silently do the opposite of what was asked. |
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… |
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… |
card_id | string | No | — |
Errors this endpoint can return
401 · 403 · 404 · 422