Skip to main content

Add Ticket Link

POST 

/api/support/agent/tickets/:ticket/links

Links the ticket to an external reference — an issue tracker item, an error tracker event, a deploy, another ticket, an internal record, or an arbitrary URL. Linking the same (kind, ref) pair again is a no-op update rather than a duplicate. Only deploy and record kinds are shown to the customer; the rest (jira, sentry, ticket, url) are agent-only.

Required scope: support:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Request body:

  • kind (required, string) — one of: jira, sentry, deploy, record, ticket, url
  • ref (required, string, max 255) — an issue key, event id, build, or record id
  • url (optional, string, valid absolute URL, max 2048)
  • label (optional, string, max 255) — defaults to ref when omitted

Authentication: Bearer token with the support:write scope, or an authenticated session, from a caller with an active support role that can work tickets.

If this ticket was merged into another ticket, the request is refused with a 422 whose merged_into (id, number) names the live ticket — send the action there instead.

Request

Responses

Created

Response Headers
    Content-Type