HighLevel: Create lead form

← Ad publishing operations · Get started

Operation gohighlevel.li_create_lead_form

Provider route: POST /ad-publishing/linkedin/{accountId}/form. 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["adPublishing"]["liCreateLeadForm"]>[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.adPublishing.liCreateLeadForm(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.ad_publishing.li_create_lead_form(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.accountId	string	Required within parent
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
query.isDraft	boolean	Optional
body	Model	Required within parent	Expand Create lead form — request body — body

Referenced models: Create lead form — 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
$	JSON	Root

Schemas

6 more schemas are linked from the tables above, on the schema pages.

Create lead form — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
content	JSON	Required within parent	Form content
content (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions
creationLocale	JSON	Required within parent	Creation locale
creationLocale (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body creation Locale country, language
hiddenFields	array	Optional	Hidden fields
hiddenFields[]	Model	Each item	Expand Create lead form — request body — body hidden Fields item
name	string	Required within parent	Form name
owner	JSON	Required within parent	Form owner
owner (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body owner sponsored Account
state	string	Required within parent	Form state One of: PUBLISHED

Referenced models: Create lead form — request body — body creation Locale country, language, Create lead form — request body — body hidden Fields item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions, Create lead form — request body — body owner sponsored Account

Create lead form — request body — body creation Locale country, language

Field	Type	Presence	Description and constraints
$	object	Root
country	string	Required within parent	Country code
language	string	Required within parent	Language code

Create lead form — request body — body hidden Fields item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Field name
value	string	Required within parent	Field value

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions

Field	Type	Presence	Description and constraints
$	object	Root
description	JSON	Optional	Form description
description (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
headline	JSON	Required within parent	Form headline
headline (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
legalInfo	JSON	Required within parent	Legal information
legalInfo (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url
postSubmissionInfo	JSON	Required within parent	Post-submission info
postSubmissionInfo (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message
questions	array	Required within parent	Form questions
questions[]	Model	Each item	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message

Create lead form — request body — body owner sponsored Account

Field	Type	Presence	Description and constraints
$	object	Root
sponsoredAccount	string	Required within parent	Sponsored account URN

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item

Field	Type	Presence	Description and constraints
$	object	Root
name	string	Required within parent	Question field name
predefinedField	string	Optional	Predefined field identifier
question	JSON	Required within parent	Question text
question (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
questionDetails	JSON	Required within parent	Question type details
questionDetails (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions questions item question Details multiple Choice Question Details, text Question Details

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url

Field	Type	Presence	Description and constraints
$	object	Root
consents	array	Required within parent	Consent entries
consents[]	Model	Each item	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url consents item
legalDisclaimer	JSON	Optional	Legal disclaimer text
legalDisclaimer (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized
privacyPolicyUrl	string	Required within parent	Privacy policy URL

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions legal Info consents, legal Disclaimer, privacy Policy Url consents item, Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Field	Type	Presence	Description and constraints
$	object	Root
localized	object	Required within parent	Locale-keyed string map

Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions post Submission Info call To Action, message

Field	Type	Presence	Description and constraints
$	object	Root
callToAction	JSON	Required within parent	Post-submission call to action
callToAction (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE
message	JSON	Required within parent	Thank-you message
message (allOf 1)	Model	All variants apply	Expand Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized

Referenced models: Create lead form — request body — body content description, headline, legal Info, post Submission Info, questions headline localized, Create lead form — request body — body / content / description, headline, legalInfo, postSubmissionInfo, questions / postSubmissionInfo / callToAction, message / callToAction / callToActionLabel: VISIT COMPANY WEBSITE, DOWNLOAD NOW, TRY NOW, VIEW NOW, LEARN MORE

Policy, approvals and errors

SDK function policy ID: gohighlevel.li_create_lead_form. Catalog operation: li-create-lead-form. 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: ["adPublishing.write"]

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

Official provider source