Create external link

POST/workspaces/{organizationId}/external-links

Path parameters

organizationIdstringrequired

Request body

application/json

entityTypestringrequired

Allowed:issueprojectcustomerdocument

entityIdstringrequired

urlstring<uri>required

labelstring

Responses

201External link created

idstringrequired

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

urlstringrequired

labelstring | nullrequired

createdAtstringrequired

404Entity not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

entityTypestring*entityIdstring*urlstring*labelstring

Request

curl -X POST "/workspaces/string/external-links" \
  -H "Content-Type: application/json" \
  -d '{
  "entityType": "issue",
  "entityId": "string",
  "url": "http://example.com",
  "label": "string"
}'

const response = await fetch("/workspaces/string/external-links", {
  method: "POST",
  headers: {
    "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(
    "/workspaces/string/external-links",
    headers={
        "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",
  "createdAt": "string"
}