HighLevel · Schema

CreateLeadFormDTO

CompanySoftware-as-a-ServiceMarketingCRMAutomationMarketing Automation

Properties

Name Type Description
type string Lead form type
name string Lead form name
locationId string Location identifier
greetingCard object Greeting card config
questions array List of questions displayed on the lead form
questionPageHeadline string Question page headline
privacyPolicyLink string Privacy policy URL
privacyPolicyText string Privacy policy text
customDisclaimer object Custom disclaimer config
thankYouPage object Thank you page config
View JSON Schema on GitHub

JSON Schema

highlevel-create-lead-form-dto-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/highlevel/main/json-schema/highlevel-create-lead-form-dto-schema.json",
  "title": "CreateLeadFormDTO",
  "x-generated": "2026-09-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/highlevel-ad-manager-openapi.json#/components/schemas/CreateLeadFormDTO",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Lead form type",
      "enum": [
        "MORE_VOLUME",
        "HIGHER_INTENT"
      ]
    },
    "name": {
      "type": "string",
      "description": "Lead form name"
    },
    "locationId": {
      "type": "string",
      "description": "Location identifier"
    },
    "greetingCard": {
      "description": "Greeting card config",
      "allOf": [
        {
          "$ref": "#/$defs/GreetingCard"
        }
      ]
    },
    "questions": {
      "description": "List of questions displayed on the lead form",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FormQuestion"
      }
    },
    "questionPageHeadline": {
      "type": "string",
      "description": "Question page headline"
    },
    "privacyPolicyLink": {
      "type": "string",
      "description": "Privacy policy URL"
    },
    "privacyPolicyText": {
      "type": "string",
      "description": "Privacy policy text"
    },
    "customDisclaimer": {
      "description": "Custom disclaimer config",
      "allOf": [
        {
          "$ref": "#/$defs/CustomDisclaimer"
        }
      ]
    },
    "thankYouPage": {
      "description": "Thank you page config",
      "allOf": [
        {
          "$ref": "#/$defs/ThankYouPage"
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "locationId",
    "questions",
    "privacyPolicyLink",
    "thankYouPage"
  ],
  "$defs": {
    "CustomDisclaimer": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Disclaimer title"
        },
        "body": {
          "type": "string",
          "description": "Disclaimer body text"
        },
        "checkboxes": {
          "description": "Consent checkboxes the user must agree to before submitting the form",
          "type": "array",
          "items": {
            "$ref": "#/$defs/CustomDisclaimerCheckbox"
          }
        }
      },
      "required": [
        "title",
        "body"
      ]
    },
    "CustomDisclaimerCheckbox": {
      "type": "object",
      "properties": {
        "is_required": {
          "type": "boolean",
          "description": "Checkbox required flag"
        },
        "text": {
          "type": "string",
          "description": "Checkbox text label"
        },
        "key": {
          "type": "string",
          "description": "Checkbox unique key"
        }
      },
      "required": [
        "is_required",
        "text",
        "key"
      ]
    },
    "FormQuestion": {
      "type": "object",
      "properties": {
        "label": {
          "type": "string",
          "description": "Question label text shown to the user"
        },
        "key": {
          "type": "string",
          "description": "Question key"
        },
        "type": {
          "type": "string",
          "description": "Question input type — use a prefilled type for standard fields or CUSTOM / SHORT_ANSWER for freeform questions",
          "enum": [
            "CUSTOM",
            "CITY",
            "COMPANY_NAME",
            "COUNTRY",
            "DATE_OF_BIRTH",
            "EMAIL",
            "FIRST_NAME",
            "FULL_NAME",
            "GENDER",
            "JOB_TITLE",
            "LAST_NAME",
            "MARITAL_STATUS",
            "MILITARY_STATUS",
            "PHONE",
            "POST_CODE",
            "RELATIONSHIP_STATUS",
            "STATE",
            "STREET_ADDRESS",
            "WORK_EMAIL",
            "WORK_PHONE_NUMBER",
            "ZIP",
            "SHORT_ANSWER"
          ]
        },
        "options": {
          "description": "Answer options for multiple-choice questions (only applies to CUSTOM type)",
          "type": "array",
          "items": {
            "$ref": "#/$defs/FormQuestionOption"
          }
        }
      },
      "required": [
        "key",
        "type"
      ]
    },
    "FormQuestionOption": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "description": "Option key"
        },
        "value": {
          "type": "string",
          "description": "Option value"
        }
      },
      "required": [
        "key",
        "value"
      ]
    },
    "GreetingCard": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Greeting card title"
        },
        "style": {
          "type": "string",
          "description": "Greeting card style"
        },
        "content": {
          "description": "Greeting card content",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "title",
        "style",
        "content"
      ]
    },
    "ThankYouPage": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Thank you page title"
        },
        "body": {
          "type": "string",
          "description": "Thank you page body"
        },
        "buttonText": {
          "type": "string",
          "description": "Button text label"
        },
        "buttonType": {
          "type": "string",
          "description": "Button action type"
        },
        "buttonLink": {
          "type": "string",
          "description": "Button destination link"
        },
        "businessPhone": {
          "type": "string",
          "description": "Business phone number"
        },
        "countryCode": {
          "type": "string",
          "description": "Phone country code"
        }
      },
      "required": [
        "title",
        "body",
        "buttonText",
        "buttonType"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/highlevel-create-lead-form-dto"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.