SCH

Interact with SCH API
Join our community

Actions5

Overview

The SCH node allows users to interact with the SCH API, specifically to manage lead data. The "Update Lead" operation under the "SCH" resource enables updating existing lead information such as contact details and job-related preferences. This node is useful in scenarios where you want to keep your lead database current by programmatically modifying lead records based on new or corrected information.

Practical examples include:

  • Automatically updating a lead's contact info after receiving updated details from a CRM or form submission.
  • Changing the job type or lead source for leads based on marketing campaign responses.
  • Correcting address information for leads to improve delivery or service accuracy.

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 part of the lead's address.
City The city part of the lead's address.
State The state part of the lead's address.
ZipCode The postal code part of the lead's address.
Lead Source The origin or source from which the lead was acquired (e.g., referral, campaign).
Job Type The type of job associated with the lead. Options: Solar, Roof, HVAC, Battery.

Output

The node outputs JSON data representing the updated lead record as returned by the SCH API. This typically includes all fields of the lead after the update operation, reflecting the new values set during execution.

If the node supports binary data output, it would generally relate to file attachments or documents linked to the lead, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API key credential for authenticating with the SCH API.
  • Needs the base URL of the SCH API configured in the node credentials.
  • The node sends requests with Accept and Content-Type headers set to application/json.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
  • Invalid input data: Missing or incorrectly formatted fields (e.g., invalid email format) may cause the API to reject the update.
  • Network issues: Verify connectivity to the SCH API endpoint and correct base URL configuration.
  • API errors: If the SCH API returns errors, check the error message for details such as lead not found or invalid job type.

Links and References

Discussion