HighLevel: Update Link

← Links operations · Get started

Operation gohighlevel.update_link

Provider route: PUT /links/{linkId}. Alter supplies the connection’s credentials and routing.

Call through Alter

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

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

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

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.links.update_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.linkId	string	Required within parent
body	Model	Required within parent	Expand Update Link — request body — body

Referenced models: Update Link — 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
$	Model	Root	Expand Create Link — response body

Referenced models: Create Link — response body

Schemas

Create Link — response body

Field	Type	Presence	Description and constraints
$	object	Root
link	JSON	Optional	The trigger link object
link (allOf 1)	Model	All variants apply	Expand Get Links — response body — links item

Referenced models: Get Links — response body — links item

Update Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Display name of the trigger link
redirectTo	string	Required within parent	URL or variable to redirect to when the trigger link is clicked

Get Links — response body — links item

Field	Type	Presence	Description and constraints
$	object	Root
fieldKey	string	Optional	Template variable key used to reference this trigger link
id	string	Optional	Unique identifier of the trigger link
locationId	string	Optional	Location ID this trigger link belongs to
name	string	Optional	Display name of the trigger link
redirectTo	string	Optional	URL or variable to redirect to when the trigger link is clicked

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_link. Catalog operation: update-link. 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: ["links.write"]

Pinned headers: {"Version": "v3"}

Official provider source