HighLevel: Create Snapshot Share Link

← Snapshots operations · Get started

Operation gohighlevel.create_snapshot_share_link

Provider route: POST /snapshots/share/link. 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["snapshots"]["createSnapshotShareLink"]>[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.snapshots.createSnapshotShareLink(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.snapshots.create_snapshot_share_link(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Required within parent	Additional keys: not allowed
query.companyId	string	Required within parent
body	Model	Required within parent	Expand Create Snapshot Share Link — request body — body

Referenced models: Create Snapshot Share 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 Snapshot Share Link — response body

Referenced models: Create Snapshot Share Link — response body

Schemas

Create Snapshot Share Link — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
relationship_number	string	Optional	Comma separated Relationship number of Agencies to create agency restricted share link
share_location_id	string	Optional	Comma separated Sub-Account ids to create sub-account restricted share link
share_type	string	Required within parent	Type of share link to generate One of: link, permanent_link, agency_link, location_link
snapshot_id	string	Required within parent	id for snapshot to be shared

Create Snapshot Share Link — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Optional	id for shared snapshot
shareLink	string	Optional	Share Link for snapshot

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_snapshot_share_link. Catalog operation: create-snapshot-share-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: ["snapshots.write"]

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

Official provider source