Issue remote links

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:

put/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/remotelink/{linkId}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: write:jira-work)
    • none

Path parameters

issueIdOrKeystring required
Example:10000

The ID or key of the issue.

linkIdstring required
Example:10000

The ID of the remote issue link.

Request body

globalIdstring

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.

relationshipstring

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

Response

Returned if the request is successful.

unknown required

Changes

No recorded changes to this operation across all 26 revisions of this API.