Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions68

Overview

This node integrates with the Magnet Customer API to manage custom field blocks. Specifically, the Create operation for the Custom Field Block resource allows users to create a new block of custom fields associated with various features such as contacts, deals, organizations, or staff. This is useful in scenarios where you want to organize custom fields into logical groups (blocks) for better data management and UI presentation within the Magnet Customer system.

Practical examples include:

  • Creating a custom field block named "Additional Contact Info" for contacts to group related custom fields.
  • Organizing deal-related custom fields under a block called "Financial Details".
  • Grouping staff-related custom fields under a block like "Employee Certifications".

Properties

Name Meaning
Authentication Method of authentication: either "API Token" or "OAuth2".
Name The name of the custom field block to be created.
Feature The feature this block belongs to. Options: "Contact", "Deal", "Organization", "Staff".
Position Numeric position/order of the block relative to other blocks.
Is Expanded Boolean indicating whether the block should be expanded by default in the UI.
Summary Display Boolean indicating whether to display this block in summary views.

Note: There are several hidden properties related to "Life Cycle" and "Source" which are preset and not user-configurable in the UI.

Output

The node outputs JSON data representing the newly created custom field block. The structure typically includes details such as the block's ID, name, feature association, position, and display settings. This output can be used downstream in workflows to reference the created block or to confirm successful creation.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Magnet Customer API.
  • Requires either an API token or OAuth2 credentials configured in n8n for authentication.
  • The node depends on internal request functions that handle API calls to Magnet Customer endpoints.

Troubleshooting

  • Common Issues:

    • Invalid or missing authentication credentials will cause API request failures.
    • Providing invalid or empty values for required fields like "Name" or "Feature" will result in errors.
    • Network connectivity issues may prevent communication with the Magnet Customer API.

  • Error Messages:

    • Errors returned from the API will be passed through; typical messages might indicate unauthorized access, validation errors on input fields, or server errors.
    • If the node is set to continue on fail, error details will appear in the output JSON under an error property.

  • Resolutions:

    • Ensure valid API credentials are configured.
    • Double-check required input properties are correctly set.
    • Verify network connectivity and API endpoint availability.

Links and References

Discussion