HighLevel: Create Redirect

← Funnels operations · Get started

Operation gohighlevel.create_redirect

Provider route: POST /funnels/lookup/redirect. 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["funnels"]["createRedirect"]>[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.funnels.createRedirect(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.funnels.create_redirect(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Create Redirect — request body — body

Referenced models: Create Redirect — 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 Redirect — response body

Referenced models: Create Redirect — response body

Schemas

Create Redirect — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: funnel, website, url, all
domain	string	Required within parent
locationId	string	Required within parent
path	string	Required within parent
target	string	Required within parent

Create Redirect — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Data containing details of the created redirect
data (allOf 1)	Model	All variants apply	Expand Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Referenced models: Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Create Redirect — response body — data action, domain, id, location Id, path, path Lowercase, target, type

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	Action performed by the redirect
domain	string	Required within parent	Domain where the redirect occurs
id	string	Required within parent	Unique identifier of the redirect
locationId	string	Required within parent	Identifier of the location associated with the redirect
path	string	Required within parent	Original path that will be redirected
pathLowercase	string	Required within parent	Lowercase version of the original path
target	string	Required within parent	Target URL to which the original path will be redirected
type	string	Required within parent	Type of redirect (e.g., Permanent, Temporary)

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_redirect. Catalog operation: create-redirect. 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: ["funnels/redirect.write"]

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

Official provider source