board-github

DELETE /v1/board-github/links/{linkId}/items/{itemId}

Remove an item from the GitHub Project, permanently.

すべての board-github エンドポイント

すべての開発者向けドキュメント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X DELETE https://api.zinndigital.com/v1/board-github/links/{linkId}/items/{itemId}?confirm=<confirm> \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

There is no undo, on either side. For a draft item GitHub destroys the content outright; for an issue or a pull request the item leaves the project and the issue itself survives. A customer cannot be expected to know which of those they are about to do, so the screen says it and this endpoint refuses without an explicit confirmation. confirm must equal the item's own GitHub node id (item_node_id), not a boolean and not the word "delete". A boolean confirms that you meant to delete something; the node id confirms which one, so a stale tab, a re-sorted board or a double submit that lands on a neighbouring row is refused rather than granted. Archiving is the reversible alternative and is usually what a person clearing a Done column actually wants — see the archive sub-resource.

パラメータ

名前タイプ必須これがその内容です
linkId (path)stringはいThe GitHub Projects connection.
itemId (path)stringはいThe item, by OUR id — not GitHub's node id, which is not a path-safe value.
confirm (query)stringはいThe item's own item_node_id. A query parameter rather than a request body because a DELETE body is dropped by enough proxies that a confirmation carried in one silently…

このエンドポイントが返すエラー

401 · 403 · 404 · 422