Create external link

POST/workspaces/{organizationId}/external-links

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

organizationIdstringrequired

Request body

application/json

entityTypestringrequired

Allowed:issueprojectcustomerdocument

entityIdstringrequired

urlstring<uri>required

labelstring

Responses

201

External link created

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

urlstringrequired

labelstring | nullrequired

verificationStatusstringrequired

Allowed:verifiedfailedunreachableunchecked

verifiedAtstring | nullrequired

resolvedUrlstring | nullrequired

resolvedTitlestring | nullrequired

httpStatusnumber | nullrequired

createdAtstringrequired

404

Entity 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*

Bodyapplication/json

entityTypestring*entityIdstring*urlstring*labelstring

Request

curl -X POST 'https://pile.nyc/workspaces/string/external-links' \
  -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", {
  method: "POST",
  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.post(
    "https://pile.nyc/workspaces/string/external-links",
    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"
}