Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

The node integrates with the Magnet Customer API to update organization records. It allows users to modify details of an existing organization by specifying its ID and providing updated information such as contact details, address, custom fields, and more. This node is useful in scenarios where you need to keep your CRM or customer database synchronized with external data sources or automate updates based on workflow triggers.

Practical examples include:

  • Automatically updating organization contact info when a form is submitted.
  • Syncing address changes from another system into Magnet Customer.
  • Enriching organization records with additional custom field data during lead qualification.

Properties

Name Meaning
Authentication Method used for authenticating API requests. Options: "API Token" or "OAuth2".
Organization ID The unique identifier of the organization record to update. Required to specify which organization to modify.
Fullname The full name of the organization contact.
E-Mail Email address of the organization contact.
Phones Collection of phone numbers associated with the organization. Allows adding multiple phone entries with their number values.
Birthdate The birthdate of the contact person related to the organization.
Document (CPF/CNPJ) Identification document number of the contact (e.g., CPF or CNPJ).
State State or region of the organization's address.
City City of the organization's address.
Address Street address of the organization.
Address Number Number component of the street address.
Complement Address Additional address information (e.g., apartment, suite).
Neighborhood Neighborhood or district of the organization's location.
CEP Postal code (CEP) of the organization's address.
Owners Owners associated with the organization contact.
Custom Fields A collection of custom fields to set on the organization. Each custom field requires a field name or ID and a value. Supports adding multiple custom fields dynamically.
Encode Custom Fields Boolean option indicating whether custom fields should be automatically encoded. By default, custom fields require IDs instead of names; enabling this encodes them automatically. Useful for simplifying input handling.
Source Hidden property set to "n8n" indicating the source of the contact data.

Output

The node outputs JSON data representing the updated organization object returned by the Magnet Customer API. This includes all standard and custom fields reflecting the new state after the update operation.

If the API supports binary data output (not indicated here), it would typically represent attachments or files related to the organization, but this node primarily deals with JSON data.

Dependencies

  • Requires access to the Magnet Customer API.
  • Needs either an API token or OAuth2 credentials configured in n8n for authentication.
  • The node depends on internal helper functions to make HTTP requests to the API endpoints.
  • Some properties load options dynamically via API calls (e.g., custom fields), so network connectivity and proper permissions are necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Organization ID will cause the update to fail.
    • Incorrect authentication credentials will result in authorization errors.
    • Providing invalid custom field IDs or values may cause the API to reject the request.
    • Network connectivity problems can prevent successful API communication.

  • Error messages:

    • "error": "Organization not found" — Verify the Organization ID is correct.
    • "error": "Unauthorized" — Check that the API token or OAuth2 credentials are valid and have required scopes.
    • "error": "Invalid custom field" — Ensure custom field IDs and values conform to expected formats.

  • Resolutions:

    • Double-check all required fields before execution.
    • Confirm API credentials and permissions.
    • Use the "Encode Custom Fields" option if unsure about custom field formatting.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion