Actions104
- Custom Field Actions
- Custom Field Block Actions
- Custom Field Type Actions
- Customer Actions
- Deal Actions
- Lead Actions
- Meeting Actions
- Meeting Room Actions
- Meeting Type Actions
- Organization Actions
- Pipeline Actions
- Prospect Actions
- Staff Actions
- Task Actions
- Ticket Actions
- Treatment Actions
- Treatment Type Actions
- Workspace Actions
Custom Field → Create
AI-generatedOverview
This node operation creates a new custom field in the Magnet Customer system. It allows users to define a custom field's name, feature association (such as Contact, Deal, Organization, or Staff), field type, order, possible values for enum/set types, sub-field settings, and various visibility and editability settings. This operation is useful for customizing data structures in Magnet Customer to better fit specific business needs, such as adding tailored fields to contacts or deals for enhanced data capture and management.
Use Case Examples
- Creating a custom field named 'Customer Priority' for the Contact feature with a field type of 'enum' and predefined values like 'High', 'Medium', and 'Low'.
- Adding a custom date field to Deals to track contract expiration dates.
- Setting up a custom text field for Staff to record certifications or special skills.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating API requests, either via API Token or OAuth2. |
| Name | The name of the custom field to be created. |
| Feature | The feature to which the custom field belongs, 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. This can be selected from a list or specified by ID. |
| Order | The order position of the custom field among other fields. |
| Values (for Enum/Set Types) | Defines possible values for Enum or Set field types, entered as multiple separate values. |
| Sub Field Settings | A JSON object specifying additional settings for sub-fields, 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- Unique identifier of the created custom field.name- Name of the created custom field.feature- Feature to which the custom field belongs.fieldType- Type of the custom field.order- Order position of the custom field.values- Possible values for Enum or Set field types.subFieldSettings- JSON object of sub field settings.settingsvisibleOnView- Visibility setting on view.visibleOnViewWhen- Conditions for visibility on view.visibleOnViewIfFilled- Visibility if filled setting.visibleOnViewIfFilledWhen- Conditions for visibility if filled.editable- Editability setting.editableWhen- Conditions for editability.creatable- Creatability setting.creatableWhen- Conditions for creatability.
Dependencies
- An API key credential or OAuth2 authentication token for Magnet Customer API
Troubleshooting
- Ensure the API credentials (API Token or OAuth2) are correctly configured and valid to avoid authentication errors.
- Verify that the 'Field Type Name or ID' corresponds to a valid custom field type available in the Magnet Customer system.
- When specifying values for Enum or Set types, ensure values are correctly formatted and separated as required.
- If the node fails to create the custom field, check the API response for error messages related to permissions or invalid data formats.