Shipeasy
APIOperations

Link related items

Edits how this queue item relates to others: which items block it ("blocked by"), which items it blocks ("blocking"), and which item it duplicates…

Edits how this queue item relates to others: which items block it ("blocked by"), which items it blocks ("blocking"), and which item it duplicates ("duplicate of"). The blocker lists are incremental — already-linked or never-linked items are no-ops and every other relation is left as is; duplicateOf sets or (with null) clears the one canonical item. An item with a blocker that is not resolved/wont_fix sits in the dashboard's Blocked lane. The relations show on ops get as blockedBy / blocking / duplicateOf / duplicates.

A link that would make an item block or duplicate itself — directly or through a chain — is rejected with 409; an item from another project doesn't resolve (404). Marking an item a duplicate of a still-open item closes it as wont_fix; if the canonical is already resolved/wont_fix (or the item itself is already closed) its status is left alone.

Use cases
  • This item can't move until #12 lands — { "addBlockedBy": ["12"] }.
  • Split work: this item gates #20 and #21 — { "addBlocking": ["20", "21"] }.
  • The dependency turned out not to be one — { "removeBlockedBy": ["12"] }.
  • Same bug was filed twice — { "duplicateOf": "8" } on the newer item — it closes as wont_fix while #8 is open.
PATCH
/api/admin/ops/{handle}/links

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Path Parameters

handle*string

Per-project item number (e.g. 7) or the full ops item id.

Length1 <= length <= 128

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://shipeasy.ai/api/admin/ops/string/links" \  -H "Content-Type: application/json" \  -d '{    "addBlockedBy": [      "12"    ]  }'
{
  "id": "fb_01j7w8a1b2c3d4e5f6g7h8i9j0",
  "blockedBy": [
    {
      "id": "fb_01j7w8a1b2c3d4e5f6g7h8i9j1",
      "number": 12,
      "type": "bug",
      "title": "Checkout total ignores the coupon",
      "status": "in_progress"
    }
  ],
  "blocking": [],
  "duplicateOf": null,
  "duplicates": []
}
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?