board-github

PUT /v1/board-github/links/{linkId}/items/{itemId}/field

Set or clear one field value on a GitHub Project item.

Todos os endpoints de board-github

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

`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.

Parâmetros

NomeTipoObrigatórioO que é
linkId (path)stringSimThe GitHub Projects connection.
itemId (path)stringSimThe item, by OUR id — not GitHub's node id, which is not a path-safe value.

Corpo da requisição

NomeTipoObrigatórioO que é
field_node_idstringSim
valueobjectNão`null` CLEARS the field, through a different GitHub mutation. An empty string would set the field to the empty string.

Resposta

NomeTipoObrigatórioO que é
idstringNão
item_node_idstringNão
item_typestring<ISSUE, PULL_REQUEST, DRAFT_ISSUE, REDACTED>Não
content_numberintegerNão
repositorystringNão
titlestringNão
bodystringNão
urlstringNão
statestringNão
is_archivedbooleanNão
field_valuesobjectNãoKeyed 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_atstringNão
local_updated_atstringNãoWhen 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_idstringNão

Erros que este endpoint pode retornar

401 · 403 · 404 · 422