SCH

Interact with SCH API

SCH → Create Lead

AI-generated

Overview

The SCH node allows users to interact with the SCH API, specifically to create new leads in the system. This operation is useful for automating lead generation workflows, such as capturing potential customer information from forms or other sources and sending it directly to SCH for follow-up and management.

Typical use cases include:

  • Automatically adding new sales leads collected from a website or CRM into SCH.
  • Integrating marketing platforms with SCH to streamline lead tracking.
  • Creating leads with detailed contact and job-related information to facilitate targeted sales efforts.

For example, a solar installation company could use this node to automatically create leads with customer contact details and specify the type of job (Solar, Roof, HVAC, Battery) they are interested in.

Properties

Name Meaning
First Name The lead's first name.
Last Name The lead's last name.
Email The lead's email address.
Phone The lead's phone number.
Street The street address of the lead.
City The city where the lead is located.
State The state where the lead is located.
ZipCode The postal code of the lead's address.
Lead Source The source from which the lead originated (e.g., referral, website).
Job Type The type of job the lead is interested in. Options: Solar, Roof, HVAC, Battery.

Output

The node outputs JSON data representing the response from the SCH API after creating the lead. This typically includes confirmation details about the newly created lead, such as an ID, status, and any other metadata returned by the API.

If the node supports binary data output, it would be related to attachments or documents associated with the lead, but based on the provided code and properties, the primary output is JSON data confirming lead creation.

Dependencies

  • Requires an active connection to the SCH API via an API key credential.
  • The base URL for the SCH API must be configured in the node credentials.
  • The node sends HTTP requests with JSON payloads to the SCH API endpoint.

Troubleshooting

  • Common issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or incomplete lead data may result in validation errors from the API.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Authentication errors usually indicate missing or incorrect API keys; verify credentials.
    • Validation errors often specify which required fields are missing or malformed; ensure all mandatory fields like first name, last name, and email are correctly filled.
    • Timeout or network errors suggest checking internet connectivity or SCH API service status.

Links and References

Discussion