Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Prospect → Create

AI-generated

Overview

This node operation creates a new prospect contact in the Magnet Customer system. It allows users to input detailed contact information such as fullname, email, phone numbers, gender, birthdate, work, marital status, document ID, legal type, address details, owners, and custom fields. This operation is useful for adding new potential customers or leads into the CRM system for further engagement and tracking.

Use Case Examples

  1. Creating a new prospect with full contact details including multiple phone numbers and custom fields for personalized marketing campaigns.
  2. Adding a prospect with basic information like fullname and email to start lead nurturing workflows.

Properties

Name Meaning
Authentication Method of authentication to use for the API request (API Token or OAuth2).
Fullname The full name of the prospect contact.
E-Mail The email address of the prospect contact.
Phones Collection of phone numbers for the prospect contact, allowing multiple entries.
Gender The gender of the prospect contact (Male or Woman).
Birthdate The birthdate of the prospect contact.
Work The work or occupation of the prospect contact.
Marital Status The marital status of the prospect contact.
Document (CPF/CNPJ) The document ID of the prospect contact (e.g., CPF or CNPJ).
Legal Type The legal type of the prospect contact (Physical or Legal entity).
State The state of the prospect contact.
City The city of the prospect contact.
Address The address of the prospect contact.
Address Number The address number of the prospect contact.
Complement Address Additional address information or complement.
Neighborhood The neighborhood of the prospect contact.
CEP The postal code (CEP) of the prospect contact.
Owners Owners associated with the prospect contact.
Custom Fields Custom fields to set additional values not predefined, allowing multiple custom field entries.

Output

JSON

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

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure all required fields are correctly filled to avoid validation errors from the API.
  • Authentication errors may occur if the API token or OAuth2 credentials are invalid or expired; verify credentials.
  • Custom fields must be correctly referenced by their IDs or names as per the API requirements to avoid errors.
  • Network or API downtime can cause request failures; retry or check API status if errors persist.

Links

Discussion