Atlassian: Update remote issue link by ID

← Issue remote links operations · Get started

Operation atlassian.updateremoteissuelink

Provider route: PUT /{cloudId}/rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/atlassian with npm, or alter-sdk-atlassian with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { AtlassianIntegration } from "@alter-ai/atlassian";

async function execute(input: Parameters<AtlassianIntegration["issueRemoteLinks"]["updateRemoteIssueLink"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new AtlassianIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issueRemoteLinks.updateRemoteIssueLink(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_atlassian import AtlassianIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = AtlassianIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issue_remote_links.update_remote_issue_link(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.cloudId	string	Required within parent	Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
path.issueIdOrKey	string	Required within parent
path.linkId	string	Required within parent
body	Model	Required within parent	Expand Update remote issue link by ID — request body — body

Referenced models: Update remote issue link by ID — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	null	Root

Schemas

Update remote issue link by ID — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details of a remote issue link. Additional keys: allowed
application	Model	Optional	Expand Update remote issue link by ID — request body — body application Details of the remote application the linked item is in. For example, trello.
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	Model	Required within parent	Expand Update remote issue link by ID — request body — body object Details of the item linked to.
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.

Referenced models: Update remote issue link by ID — request body — body application, Update remote issue link by ID — request body — body object

Update remote issue link by ID — request body — body application

Field	Type	Presence	Description and constraints
$	object	Root	The application the linked item is in. Additional keys: allowed
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.

Update remote issue link by ID — request body — body object

Field	Type	Presence	Description and constraints
$	object	Root	The linked item. Additional keys: allowed
icon	Model	Optional	Expand Update remote issue link by ID — request body — body object icon Details of the icon for the item. If no icon is defined, the default link icon is used in Jira.
status	Model	Optional	Expand Update remote issue link by ID — request body — body object status The status of the item.
summary	string	Optional	The summary details of the item.
title	string	Required within parent	The title of the item.
url	string	Required within parent	The URL of the item.

Referenced models: Update remote issue link by ID — request body — body object icon, Update remote issue link by ID — request body — body object status

Update remote issue link by ID — request body — body object icon

Field	Type	Presence	Description and constraints
$	object	Root	An icon. If no icon is defined: * for a status icon, no status icon displays in Jira. * for the remote object icon, the default link icon displays in Jira. Additional keys: allowed
link	string	Optional	The URL of the tooltip, used only for a status icon. If not set, the status icon in Jira is not clickable.
title	string	Optional	The title of the icon. This is used as follows: * For a status icon it is used as a tooltip on the icon. If not set, the status icon doesn't display a tooltip in Jira. * For the remote object icon it is used in conjunction with the application name to display a tooltip for the link's icon. The tooltip takes the format "\[application name\] icon title". Blank itemsare excluded from the tooltip title. If both items are blank, the icon tooltop displays as "Web Link".
url16x16	string	Optional	The URL of an icon that displays at 16x16 pixel in Jira.

Update remote issue link by ID — request body — body object status

Field	Type	Presence	Description and constraints
$	object	Root	The status of the item. Additional keys: allowed
icon	Model	Optional	Expand Update remote issue link by ID — request body — body object icon Details of the icon representing the status. If not provided, no status icon displays in Jira.
resolved	boolean	Optional	Whether the item is resolved. If set to "true", the link to the issue is displayed in a strikethrough font, otherwise the link displays in normal font.

Referenced models: Update remote issue link by ID — request body — body object icon

Policy, approvals and errors

SDK function policy ID: atlassian.updateremoteissuelink. Catalog operation: updateremoteissuelink. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["write:jira-work"]

No-content response statuses: [204]

Official provider source