Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Overview

This node integrates with the Magnet Customer API to manage customer data within workflows. Specifically, the "Customer" resource with the "Create" operation allows users to add new customer contacts into the Magnet system. This is useful for automating customer onboarding, syncing contact information from other systems, or bulk importing customer data.

Practical examples include:

  • Automatically creating a new customer record when a form is submitted on a website.
  • Syncing customer details from a CRM or e-commerce platform into Magnet.
  • Adding customers from marketing campaigns or lead generation tools directly into Magnet.

Properties

Name Meaning
Authentication Method of authentication: "API Token" or "OAuth2".
Fullname The full name of the customer contact (required).
E-Mail The email address of the customer contact.
Phones Collection of phone numbers associated with the contact; multiple phones can be added.
Gender Gender of the contact; options are "Male" (M) or "Woman" (F).
Birthdate The birth date of the contact.
Work The workplace or job title of the contact.
Marital Status Marital status of the contact.
Document (CPF/CNPJ) Identification document number of the contact (Brazilian CPF or CNPJ).
Legal Type Legal classification of the contact: "Physical" (individual) or "Legal" (company).
State State where the contact resides.
City City where the contact resides.
Address Street address of the contact.
Address Number Number of the street address.
Complement Address Additional address information (e.g., apartment, suite).
Neighborhood Neighborhood of the contact's address.
CEP Postal code (Brazilian postal code format).
Owners Owners associated with the contact.
Custom Fields Additional custom fields that can be set dynamically by specifying field name/ID and value.
Life Cycle Hidden property indicating the life cycle stage of the contact; default is "customer".
Source Hidden property indicating the source of the contact; default is "n8n".

Output

The node outputs JSON data representing the newly created customer record as returned by the Magnet Customer API. This typically includes the customer's unique ID, all provided fields, and any additional metadata assigned by the API.

If the node supports binary data output (not indicated here), it would represent attachments or files related to the customer, but this is not applicable for the "Create Customer" operation.

Dependencies

  • Requires an active connection to the Magnet Customer API.
  • Supports two authentication methods: API token or OAuth2 credentials.
  • The user must configure appropriate credentials in n8n for authentication.
  • The node depends on internal helper functions to make HTTP requests to the Magnet API endpoints.

Troubleshooting

  • Authentication errors: Ensure that the API token or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Validation errors: Required fields like "Fullname" must be provided; missing mandatory fields will cause the API to reject the request.
  • Custom fields issues: When setting custom fields, ensure the field IDs or names exist and are valid; otherwise, the API may return errors.
  • Network or API downtime: Temporary connectivity issues or Magnet API outages will cause request failures; retry or check service status.
  • Error messages: If the node returns an error message in the output JSON under error, review the message for clues such as invalid parameters or permission issues.

Links and References

Discussion