Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Customer → Create

AI-generated

Overview

This node allows users to create a new customer contact in the Magnet Customer system via the API. It supports setting various customer details such as fullname, email, phones, gender, birthdate, work, marital status, document, legal type, address details, owners, and custom fields. This node is useful for automating customer data entry and integration workflows where new customer records need to be added programmatically.

Use Case Examples

  1. Creating a new customer contact with fullname, email, and phone numbers.
  2. Adding a customer with detailed address and custom fields for personalized data management.

Properties

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

Output

JSON

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

Dependencies

  • Magnet Customer API

Troubleshooting

  • Ensure the API credentials (API Token or OAuth2) are correctly configured and have sufficient permissions to create customers.
  • 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, validation errors for missing or invalid fields, and API rate limits. Check the error message details and adjust input or credentials accordingly.

Links

Discussion