Update remote issue link by ID

Updates a remote issue link for an issue.

Note: Fields without values in the request are set to null.

This operation requires issue linking to be active.

This operation can be accessed anonymously.

Permissions required:

Browse projects and Link issues project permission for the project that the issue is in.

If issue-level security is configured, issue-level security permission to view the issue.

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/api/3/issue//remotelink/' \ --header 'Content-Type: application/json' \ --data-raw '{ "application": { "name": "My Acme Tracker", "type": "com.acme.tracker" }, "globalId": "system=http://www.mycompany.com/support&id=1", "object": { "icon": { "title": "Support Ticket", "url16x16": "http://www.mycompany.com/support/ticket.png" }, "status": { "icon": { "link": "http://www.mycompany.com/support?id=1&details=closed", "title": "Case Closed", "url16x16": "http://www.mycompany.com/support/resolved.png" }, "resolved": true }, "summary": "Customer support issue", "title": "TSTSUP-111", "url": "http://www.mycompany.com/support?id=1" }, "relationship": "causes" }'

Request

Path Params

issueIdOrKey

string

required

The ID or key of the issue.

linkId

string

required

The ID of the remote issue link.

Body Params application/json

Details of a remote issue link.

application

object

optional

Details of the remote application the linked item is in. For example, trello.

name

string

optional

The name of the application. Used in conjunction with the (remote) object icon title to display a tooltip for the link's icon. The tooltip takes the format "[application name] icon title". Blank items are excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link". Grouping and sorting of links may place links without an application name last.

type

string

optional

The name-spaced type of the application, used by registered rendering apps.

Additional properties

integer | number | string | boolean

optional

globalId

string

optional

An identifier for the remote item in the remote system. For example, the global ID for a remote item in Confluence would consist of the app ID and page ID, like this: appId=456&pageId=123.

Setting this field enables the remote issue link details to be updated or deleted using remote system and item details as the record identifier, rather than using the record's Jira ID.

The maximum length is 255 characters.

object

required

Details of the item linked to.

icon

object

optional

Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.

status

object

optional

The status of the item.

summary

string

optional

The summary details of the item.

title

string

required

The title of the item.

url

string

required

The URL of the item.

Additional properties

integer | number | string | boolean

optional

relationship

string

optional

Description of the relationship between the issue and the linked item. If not set, the relationship description "links to" is used in Jira.

Additional properties

integer | number | string | boolean

optional

Examples

Responses

🟢204Returned if the request is successful.

application/json

Body

No schema defined

🟠400Returned if: * the link ID is invalid. * the remote issue link does not belong to the issue. * the request body is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have permission to link issues.

🟠404Returned if the issue or remote issue link is not found or the user does not have permission to view the issue.