Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Lead → Create

AI-generated

Overview

This node creates a new lead contact in the Magnet Customer system. It is useful for automating the addition of potential customer information into a CRM or sales pipeline. For example, it can be used to capture lead details from a web form or marketing campaign and automatically add them to the Magnet Customer database.

Use Case Examples

  1. Creating a lead with fullname, email, phone numbers, and custom fields to track potential customers from a marketing campaign.
  2. Adding detailed lead information including gender, birthdate, address, and marital status for better customer profiling.

Properties

Name Meaning
Authentication Method of authentication to use for the API request (API Token or OAuth2).
Fullname The full name of the lead contact.
E-Mail The email address of the lead contact.
Phones A collection of phone numbers associated with the lead.
Gender The gender of the lead contact.
Birthdate The birthdate of the lead contact.
Work The work or occupation of the lead contact.
Marital Status The marital status of the lead contact.
Document (CPF/CNPJ) The document identifier of the lead contact (e.g., CPF or CNPJ).
Legal Type The legal type of the lead contact (Physical or Legal entity).
State The state where the lead contact is located.
City The city where the lead contact is located.
Address The address of the lead contact.
Address Number The address number of the lead contact.
Complement Address Additional address information for the lead contact.
Neighborhood The neighborhood of the lead contact.
CEP The postal code (CEP) of the lead contact.
Owners The owners associated with the lead contact.
Custom Fields Custom fields to set additional values not predefined in the node.

Output

JSON

  • _id - Unique identifier of the created lead.
  • fullname - Full name of the lead.
  • email - Email address of the lead.
  • phones - Array of phone numbers associated with the lead.
  • gender - Gender of the lead.
  • birthDate - Birthdate of the lead.
  • work - Work or occupation of the lead.
  • maritalStatus - Marital status of the lead.
  • doc - Document identifier (CPF/CNPJ) of the lead.
  • type - Legal type of the lead (physical or legal).
  • state - State of the lead.
  • city - City of the lead.
  • address - Address of the lead.
  • addressNumber - Address number of the lead.
  • complement - Complement address of the lead.
  • neighborhood - Neighborhood of the lead.
  • cep - Postal code (CEP) of the lead.
  • owners - Owners associated with the lead.
  • customFields - Custom fields set for the lead.

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and have the necessary permissions to create leads.
  • Verify that required fields such as fullname and email are provided and correctly formatted.
  • If custom fields are used, ensure the field IDs or names are valid and exist in the Magnet Customer system.
  • Common error messages may include authentication failures, missing required fields, or invalid field values. Check the error message details and adjust the input accordingly.

Links

Discussion