HighLevel: Send document

← Proposals operations · Get started

Operation gohighlevel.send_documents_contracts

Provider route: POST /proposals/document/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"]["sendDocumentsContracts"]>[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.sendDocumentsContracts(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(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 document — request body — body

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

Field	Type	Presence	Description and constraints
$	object	Root
ccRecipients	array	Optional	CC Recipient
ccRecipients[]	Model	Each item	Expand Send document — request body — body cc Recipients item
documentId	string	Required within parent	Document Id
documentName	string	Optional	Document Name
locationId	string	Required within parent	Location Id
medium	string	Optional	Medium to be used for sending the document One of: link, email
notificationSettings	JSON	Optional
notificationSettings (allOf 1)	Model	All variants apply	Expand Send document — request body — body notification Settings receive, sender
sentBy	string	Required within parent	Sent ByUser Id

Referenced models: Send document — request body — body cc Recipients item, Send document — request body — body notification Settings receive, sender

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

Send document — request body — body cc Recipients item

Field	Type	Presence	Description and constraints
$	object	Root
contactName	string	Required within parent	Contact Name
email	string	Required within parent	Email
firstName	string	Required within parent	First Name
id	string	Required within parent	Contact ID
imageUrl	string	Required within parent	Contact Image URL
lastName	string	Required within parent	Last Name

Send document — request body — body notification Settings receive, sender

Field	Type	Presence	Description and constraints
$	object	Root
receive	Model	Required within parent	Expand Send document — request body — body notification Settings receive, sender receive
sender	Model	Required within parent	Expand Send document — request body — body notification Settings receive, sender sender

Referenced models: Send document — request body — body notification Settings receive, sender receive, Send document — request body — body notification Settings receive, sender sender

Send document — request body — body notification Settings receive, sender receive

Field	Type	Presence	Description and constraints
$	object	Root
subject	string	Required within parent
templateId	string	Required within parent

Send document — request body — body notification Settings receive, sender sender

Field	Type	Presence	Description and constraints
$	object	Root
fromEmail	string	Required within parent
fromName	string	Required within parent

Policy, approvals and errors

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

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

Official provider source