HighLevel: Email Verification

← Email isv operations · Get started

Operation gohighlevel.verify_email

Provider route: POST /email/verify. 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["emailIsv"]["verifyEmail"]>[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.emailIsv.verifyEmail(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.email_isv.verify_email(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.locationId	string	Required within parent
body	Model	Required within parent	Expand Email Verification — request body — body

Referenced models: Email Verification — 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
$ (anyOf 1)	Model	Alternative	Expand Email Verification — response body — result: deliverable, undeliverable, do not send, unknown, catch all, risk: high, low, medium, unknown
$ (anyOf 2)	Model	Alternative	Expand Email Verification — response body — address, message, verified
$ (anyOf 3)	Model	Alternative	Expand Email Verification — response body — is Email Valid

Referenced models: Email Verification — response body — address, message, verified, Email Verification — response body — is Email Valid, Email Verification — response body — result: deliverable, undeliverable, do not send, unknown, catch all, risk: high, low, medium, unknown

Schemas

Email Verification — response body — address, message, verified

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Optional	Email address
message	string	Optional	Email verification failure message
verified	boolean	Required within parent	Email verification not processed

Email Verification — response body — is Email Valid

Field	Type	Presence	Description and constraints
$	object	Root
isEmailValid	boolean	Optional	Email verification status

Email Verification — response body — result: deliverable, undeliverable, do not send, unknown, catch all, risk: high, low, medium, unknown

Field	Type	Presence	Description and constraints
$	object	Root
address	string	Required within parent	Email address
leadConnectorRecommendation	JSON	Optional	Lead Connector email verification recommendation
leadConnectorRecommendation (allOf 1)	Model	All variants apply	Expand Email Verification — response body — is Email Valid
reason	array	Optional	Reason for email verification failure
reason[]	string	Each item
result	string	Required within parent	Email verification result Known values: deliverable, undeliverable, do_not_send, unknown, catch_all
risk	string	Required within parent	Risk level of email sending to bounce Known values: high, low, medium, unknown

Referenced models: Email Verification — response body — is Email Valid

Email Verification — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Email Verification type One of: email, contact
verify	string	Required within parent	Email Verification recepient (email address / contactId)

Policy, approvals and errors

SDK function policy ID: gohighlevel.verify_email. Catalog operation: verify-email. 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: ["lc-email.readonly"]

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

Official provider source