Update external link

PATCH/workspaces/{organizationId}/external-links/{id}

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

idstringrequired

Request body

application/json

entityTypestring

Allowed:issueprojectcustomerdocument

entityIdstring

urlstring<uri>

labelstring

Responses

200

External link updated

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

urlstringrequired

labelstring | nullrequired

verificationStatusstringrequired

Allowed:verifiedfailedunreachableunchecked

verifiedAtstring | nullrequired

resolvedUrlstring | nullrequired

resolvedTitlestring | nullrequired

httpStatusnumber | nullrequired

createdAtstringrequired

404

External link not found

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*idpath*

Bodyapplication/json

entityTypestringentityIdstringurlstringlabelstring

Request

curl -X PATCH 'https://pile.nyc/workspaces/string/external-links/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "entityType": "issue",
  "entityId": "string",
  "url": "http://example.com",
  "label": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/external-links/string", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"entityType\": \"issue\",\n  \"entityId\": \"string\",\n  \"url\": \"http://example.com\",\n  \"label\": \"string\"\n}"
});

import requests

response = requests.patch(
    "https://pile.nyc/workspaces/string/external-links/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"entityType\": \"issue\",\n  \"entityId\": \"string\",\n  \"url\": \"http://example.com\",\n  \"label\": \"string\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "entityType": "string",
  "entityId": "string",
  "url": "string",
  "label": "string",
  "verificationStatus": "verified",
  "verifiedAt": "string",
  "resolvedUrl": "string",
  "resolvedTitle": "string",
  "httpStatus": 0,
  "createdAt": "string"
}