Close CRM icon

Close CRM

Consume Close CRM API

Lead → Create

AI-generated

Overview

This node operation creates a new lead in the Close CRM system. It allows users to specify the lead's name (company or organization) and optionally add additional details such as description, status, user attribution, website URL, contacts, address, and custom fields. This operation is useful for automating lead generation workflows, integrating lead data from other systems, or managing leads programmatically within Close CRM.

Use Case Examples

  1. Creating a new lead with basic information like name and description.
  2. Adding multiple contacts with detailed information to a lead during creation.
  3. Including custom fields and address details to enrich the lead data.

Properties

Name Meaning
Name The name of the lead (company or organization), required for creating a lead.
Additional Fields Optional fields to provide more details about the lead such as description, status, user attribution, and website URL.
Contacts A collection of contacts associated with the lead, each with detailed fields including name, emails, phones, title, and various custom fields (text, number, date, choice, user).
Address Address details for the lead including street, city, state, ZIP code, and country.
Custom Fields Custom field values for the lead, supporting multiple types such as text, number, date, single-choice, multiple-choice, single-user, multiple-user, single-contact, and multiple-contact fields.

Output

JSON

  • id - The unique identifier of the created lead.
  • name - The name of the created lead.
  • description - The description of the created lead.
  • status_id - The status ID of the created lead.
  • user_id - The user ID attributed to the lead.
  • url - The website URL of the lead.
  • contacts - Array of contacts associated with the lead.
  • addresses - Array of addresses associated with the lead.
  • custom
    • * - Custom fields associated with the lead, with keys prefixed by 'custom.'

Dependencies

  • Close CRM API
  • an API key credential for authentication

Troubleshooting

  • Ensure the 'Name' field is provided as it is required for creating a lead; missing this will cause an error.
  • Verify that any IDs used for status or user fields are valid and exist in the Close CRM system.
  • Check that custom fields are correctly formatted and correspond to existing custom field definitions to avoid processing errors.
  • If the API request fails, confirm that the API key credential is correctly configured and has the necessary permissions.

Links

Discussion