HighLevel: Send template

← Proposals operations · Get started

Operation gohighlevel.send_documents_contracts_template

Provider route: POST /proposals/templates/send. 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["proposals"]["sendDocumentsContractsTemplate"]>[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.proposals.sendDocumentsContractsTemplate(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.proposals.send_documents_contracts_template(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 Send template — request body — body

Referenced models: Send template — 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 Send document — response body

Referenced models: Send document — response body

Schemas

Send document — response body

Field	Type	Presence	Description and constraints
$	object	Root
links	array	Required within parent	Links for all recipients
links[]	Model	Each item	Expand Send document — response body — links item
success	boolean	Required within parent	Success status

Referenced models: Send document — response body — links item

Send template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	Contact Id
locationId	string	Required within parent	Location Id
opportunityId	string	Optional	Opportunity Id
sendDocument	boolean	Optional	Send Document
templateId	string	Required within parent	Template Id
userId	string	Required within parent	User Id

Send document — response body — links item

Field	Type	Presence	Description and constraints
$	object	Root
createdBy	string	Required within parent	Created by user ID
deleted	boolean	Required within parent	Whether the document is deleted
documentId	string	Required within parent	Document ID
documentRevision	JSON	Required within parent
documentRevision (anyOf 1)	number	Alternative	Document revision number
documentRevision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entityName	string	Required within parent	Entity name that the recipient belongs to Known values: contacts, users
recipientCategory	string	Required within parent	Recipient category (recipient, cc, or bcc) Known values: recipient, cc, bcc
recipientId	string	Required within parent	Recipient ID
referenceId	string	Required within parent	Reference ID

Policy, approvals and errors

SDK function policy ID: gohighlevel.send_documents_contracts_template. Catalog operation: send-documents-contracts-template. 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: ["documents_contracts_template/sendLink.write"]

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

Official provider source