Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Custom Field Block → Create

AI-generated

Overview

This node operation creates a new Custom Field Block in the Magnet Customer system. It is useful for organizing custom fields into blocks for better management and display within features like Contact, Deal, Organization, or Staff. For example, a user can create a custom field block named "Customer Preferences" under the Contact feature to group related custom fields together.

Use Case Examples

  1. Create a custom field block named 'Customer Preferences' for the Contact feature, positioned at 1, expanded by default, and displayed in summaries.
  2. Create a custom field block for the Deal feature to group deal-specific custom fields.

Properties

Name Meaning
Authentication Selects the authentication method to use for the API request (API Token or OAuth2).
Name The name of the custom field block to create.
Feature The feature this custom field block belongs to, such as Contact, Deal, Organization, or Staff.
Position The position of the block, which determines its order relative to other blocks.
Is Expanded Whether the block should be expanded by default in the UI.
Summary Display Whether to display this block in summaries.

Output

JSON

  • _id - The unique identifier of the created custom field block.
  • name - The name of the created custom field block.
  • feature - The feature the block belongs to.
  • position - The position of the block.
  • isExpanded - Indicates if the block is expanded by default.
  • summaryDisplay - Indicates if the block is displayed in summaries.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure the API credentials are valid and have the necessary permissions to create custom field blocks.
  • Verify that all required fields (Name, Feature) are provided and correctly formatted.
  • If the API returns an error, check the error message for details such as rate limits or invalid parameters.

Discussion