Surense icon

Surense

Interact with Surense API

Actions36

Lead → Create a Lead

AI-generated

Overview

This node integrates with the Surense API to create a new Lead record. It is designed to facilitate adding potential customer leads into the Surense system, which can then be used for sales tracking, marketing campaigns, or customer relationship management.

Common scenarios where this node is beneficial include:

  • Automating lead capture from web forms or other sources.
  • Integrating lead data from external systems into Surense.
  • Enriching lead information by setting detailed attributes such as contact info, ownership, and campaign tracking parameters.

For example, you could use this node to automatically create a lead when a visitor fills out a contact form on your website, assigning the lead to a specific sales representative and tagging it with relevant marketing campaign details.

Properties

Name Meaning
First Name The lead's first name (required).
Last Name The lead's last name (required).
Owner Name or ID The owner of the lead. Choose from a list of users or specify an ID via expression (required).
Interest Name or ID The interest category of the lead. Choose from a list or specify an ID via expression (required).
Additional Parameters A collection of optional fields to provide more detailed lead information:
- Assigned User Name or ID Assigned user for the lead. Choose from a list or specify an ID via expression.
- Birth Date Lead's birth date in YYYY-MM-DD format.
- City City where the lead is located.
- Due Date Due date associated with the lead in YYYY-MM-DD format.
- Email Lead's email address.
- External ID An external identifier for the lead.
- ID Card Issue Date Date when the lead's ID card was issued (YYYY-MM-DD).
- ID Number Customer identification number.
- ID Type Type of customer ID. Options: ת.ז (1), דרכון (2), רישיון נהיגה (3), אחר (4).
- Mail Box Mailbox number.
- Notes Additional notes about the lead.
- Phone Number 1 Primary phone number.
- Phone Number 2 Secondary phone number.
- Postal Code Postal code of the lead's address.
- Source Name or ID Lead source. Choose from a list or specify an ID via expression.
- Status Name or ID Lead status. Choose from a list or specify an ID via expression.
- Street Street name of the lead's address.
- Street Number Street number of the lead's address.
- Template Name or ID Lead template. Choose from a list or specify an ID via expression.
- UTM Campaign UTM campaign parameter for marketing attribution.
- UTM Content UTM content parameter for marketing attribution.
- UTM ID UTM ID parameter for marketing attribution.
- UTM Medium UTM medium parameter for marketing attribution.
- UTM Source UTM source parameter for marketing attribution.
- UTM Term UTM term parameter for marketing attribution.

Output

The node outputs JSON data representing the newly created lead object as returned by the Surense API. This typically includes all the lead's properties such as IDs, names, contact details, status, and any additional metadata set during creation.

No binary data output is indicated.

Dependencies

  • Requires an active connection to the Surense API using OAuth2 authentication.
  • The node depends on several helper methods to load options dynamically for fields like users, lead interests, sources, statuses, and templates.
  • Proper configuration of the Surense API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Missing required fields such as first name, last name, owner, or interest will cause errors.
    • Invalid or expired API credentials will prevent successful communication with the Surense API.
    • Incorrect option selections or invalid IDs for owner, interest, source, status, or template may result in API errors.

  • Error messages:

    • Errors related to missing required parameters should be resolved by ensuring all mandatory fields are filled.
    • Authentication errors require checking and refreshing the API credentials.
    • Validation errors from the API usually indicate incorrect field values or IDs; verify that selected options exist and are valid.

Links and References

Discussion