POST/api/v1/tickets/{id}/external-links

Product availabilityAlgaPSAAlgaDesk

Add a ticket external link

Adds a ticket-level external-system reference. Only one origin link is allowed per ticket. URL must be http(s).

RBAC · ticket

Path parameters

idstring <uuid>Required

UUID path identifier from underlying resource tables.

Request body

Content type: application/json · schema WorkV1TicketExternalLinkCreateBody

entity_typestring

Defaults to 'ticket'.

Enum: ticketcomment

comment_idstring <uuid>

Required when entity_type is 'comment'.

systemstringRequired

Built-in system key or custom:<slug>.

min length 1

external_idstringRequired

min length 1

external_parent_idstringNullable

realmstringNullable

urlstring <uri>Nullable

Optional explicit link-out; must be http(s).

relationshipstring

Enum: originmirrorreference

actorobjectNullable

idstringNullable

handlestringNullable

display_namestringNullable

urlstring <uri>Nullable

external_statusstringNullable

external_updated_atstringNullable

metadataobjectNullable

Response body

Success response 201 · schema WorkV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

201

External link created.

400

Validation or request parsing failure.

401

API key missing/invalid.

403

RBAC denied for ticket resource action.

404

Ticket or sub-resource not found.

500

Unexpected controller/service failure.

POST /api/v1/tickets/{id}/external-links

cURL

curl -X POST "https://algapsa.com/api/v1/tickets/{id}/external-links" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "entity_type": "ticket",
  "comment_id": "01HN2K7VRB9PQ3Y0000000000",
  "system": "x",
  "external_id": "x",
  "external_parent_id": "string",
  "realm": "string",
  "url": "https://example.com",
  "relationship": "origin",
  "actor": {
    "id": "string",
    "handle": "string",
    "display_name": "string",
    "url": "https://example.com"
  },
  "external_status": "string",
  "external_updated_at": "string",
  "metadata": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/tickets/{id}/external-links", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "entity_type": "ticket",
    "comment_id": "01HN2K7VRB9PQ3Y0000000000",
    "system": "x",
    "external_id": "x",
    "external_parent_id": "string",
    "realm": "string",
    "url": "https://example.com",
    "relationship": "origin",
    "actor": {
      "id": "string",
      "handle": "string",
      "display_name": "string",
      "url": "https://example.com"
    },
    "external_status": "string",
    "external_updated_at": "string",
    "metadata": {}
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/tickets/{id}/external-links");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""entity_type"": ""ticket"",
  ""comment_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""system"": ""x"",
  ""external_id"": ""x"",
  ""external_parent_id"": ""string"",
  ""realm"": ""string"",
  ""url"": ""https://example.com"",
  ""relationship"": ""origin"",
  ""actor"": {
    ""id"": ""string"",
    ""handle"": ""string"",
    ""display_name"": ""string"",
    ""url"": ""https://example.com""
  },
  ""external_status"": ""string"",
  ""external_updated_at"": ""string"",
  ""metadata"": {}
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {},
  "meta": {}
}