Magnet Customer icon

Magnet Customer

Consume Magnet Customer API

Actions104

Custom Field → Update

AI-generated

Overview

This node updates a custom field in the Magnet Customer system. It allows users to modify properties of an existing custom field such as its name, feature association (e.g., contact, deal, organization, staff), field type, order, possible values for enum/set types, sub field settings, and various visibility and editability settings. This operation is useful for managing and customizing data fields dynamically within the Magnet Customer platform to better fit business needs.

Use Case Examples

  1. Updating the name and type of a custom field used in contact records.
  2. Changing the order and visibility settings of a custom field associated with deals.
  3. Adding or modifying possible values for an enum-type custom field in the staff feature.

Properties

Name Meaning
Authentication Method of authentication to use for the API request (API Token or OAuth2).
Custom Field ID The unique identifier of the custom field to update.
Name The new name to assign to the custom field.
Feature The feature this custom field belongs to, such as contact, deal, organization, or staff.
Field Type Name or ID The type of the custom field (e.g., varchar, text, enum, set, date, number). Can be selected from a list or specified by ID.
Order The order position of the custom field.
Values (for Enum/Set Types) Possible values for enum or set field types, entered as multiple separate values.
Sub Field Settings JSON object defining sub field settings, structure depends on the field type.
Settings Collection of settings controlling visibility, editability, and creatability of the custom field under various conditions.

Output

JSON

  • _id - The unique identifier of the updated custom field.
  • name - The updated name of the custom field.
  • feature - The feature the custom field belongs to (contact, deal, organization, staff).
  • fieldType - The type of the custom field (e.g., varchar, text, enum, set, date, number).
  • order - The order position of the custom field.
  • values - Possible values for enum or set field types.
  • subFieldSettings - JSON object with sub field settings.
  • settings
    • visibleOnView - Whether the field is visible on view.
    • visibleOnViewWhen - Conditions when the field is visible on view.
    • visibleOnViewIfFilled - Whether the field is visible on view if filled.
    • visibleOnViewIfFilledWhen - Conditions when the field is visible on view if filled.
    • editable - Whether the field is editable.
    • editableWhen - Conditions when the field is editable.
    • creatable - Whether the field is creatable.
    • creatableWhen - Conditions when the field is creatable.

Dependencies

  • Magnet Customer API with either API Token or OAuth2 authentication

Troubleshooting

  • Ensure the Custom Field ID is correct and exists in the Magnet Customer system to avoid 'not found' errors.
  • Verify that the authentication credentials (API Token or OAuth2) are valid and have sufficient permissions to update custom fields.
  • Check that the field type specified is valid and supported by the Magnet Customer API.
  • If updating enum or set types, ensure the values are provided correctly as multiple separate entries.
  • If the node throws errors related to JSON structure in subFieldSettings, validate the JSON format and structure according to the field type requirements.

Links

Discussion