Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Custom Field Block → Update

AI-generated

Overview

This node updates a Custom Field Block in the Magnet Customer system. It is useful for modifying the properties of an existing custom field block, such as its name, feature association, position, expansion state, and summary display settings. For example, a user can update the name of a custom field block or change its position within a feature like Contact or Deal.

Use Case Examples

  1. Update the name and position of a custom field block identified by its Block ID.
  2. Change the feature association of a custom field block from Contact to Deal.
  3. Toggle whether the custom field block is expanded by default or shown in summaries.

Properties

Name Meaning
Authentication Method of authentication to use, either API Token or OAuth2.
Block ID The unique identifier of the custom field block to update.
Name The new name to assign to the custom field block.
Feature The feature this block belongs to, such as Contact, Deal, Organization, or Staff.
Position The position of the block, which determines its order.
Is Expanded Whether the block should be expanded by default.
Summary Display Whether to display this block in summaries.

Output

JSON

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

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure the Block ID provided is correct and exists in the system to avoid 'not found' errors.
  • Verify that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to update custom field blocks.
  • Check that all required fields (Block ID, Name, Feature) are provided and correctly formatted.
  • If the update fails, review the error message for details such as invalid field values or API rate limits.

Discussion