Create a Lead with an Install

Generate a new customer record with a deal and install without agreements. You can update the records using the same integration IDs. When install fields are updated, then a completed Change Order will be automatically generated. Milestone communications are not sent out and only essential webhooks are triggered.

Body Params
string
required

This is the ID of the "Deal Type". This will determine the EPC used to create the install record. It is provided to you by the Enerflo Build Team during your onboarding. If you don't know this value, please chat with Enerflo Support.

string

This is the ID of the sales org assigned to the customer record. If you're an installer, this is only required if the record is being created on behalf of an external sales org. The sales org must have access to the deal used to generate the deal. By default this will always be the EPC. If you're using a sales org API key, then this should be left blank.

string
required

The email address provided here will be used to assign a Sales Rep to the customer. It should match the email address the Sales Rep uses to log in to Enerflo.

string
required

The customer's first name

string
required

The customer's last name

string
required

The customer's email address

string
required

The mobile phone number of the lead, used for SMS notifications and messaging.

string
required

Street address of the customer/project. Ex "123 N. Main Street"

string

Apartment number. Ex: "Apt 3", "Suite 202", "#7", "Unit A-4" etc

string
required
string
enum
required

2-character state abbreviation (ex: AL, AK, AZ, etc)

string
required
boolean

Indicates whether the customer has opted in to receive SMS communications. Customers must explicitly opt-in (verbally to a sales rep or digitally) before any SMS messages can be sent. This is required to maintain compliance with FCC, TCPA, and CTIA regulations. If not provided, the default value is false and no messages will be delivered. This value can be updated via the API or UI unless the customer has explicitly replied "STOP" to an SMS. In that case, they cannot be opted in unless they text "START".

string

The source of the lead, most often for marketing services. Valid values can be found here: https://enerflo.io/company/leadsources

string

This is the note that will be added to the customer and install record.

string

This is the most recently completed milestone on the install record. All previous milestones will not be completed, unless the 'complete_previous_milestones' flag is set to TRUE. Milestone communications will not be triggered.

boolean

When set TRUe, all previous milestones will be marked as complete. Milestone communications will not be triggered.

string

The cost of the solar system in USD.

string

The size of the solar system in kW.

string

The creation date for the install record. Use the format "YYYY-MM-DD" (e.g., "2024-12-01").

string

The primary key of this install record in your external integration system (Ex: Salesforce opportunity id, HubSpot deal id, etc). This allows you to link the Enerflo install record with your external system records.

string

Required only if install_integration_id is provided. Specifies the integration type (e.g., GoogleSheets, Salesforce, Zoho). Example list: https://docs.enerflo.io/docs/integration-record-types

string

The primary key of this customer record in your external integration system (Ex: Salesforce contact id, HubSpot contact id, etc). This allows you to link the Enerflo customer record with your external system records.

string

Required only if customer_integration_id is provided. Specifies the integration type (e.g., GoogleSheets, Salesforce, Zoho). Example list: https://docs.enerflo.io/docs/integration-record-types

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json