Mautic AdvancedInstall

Summary

Create a new custom field in Mautic for either contacts or companies with specified attributes such as label, type, alias, group, default value, and various flags controlling its behavior.

Inputs

• Authentication — Choose the authentication method (Credentials or OAuth2) to access the Mautic API.
• Field Object (required) — Select the type of object the field will be associated with: contact or company.
• Label (required) — Set the display name of the custom field.
• Type (required) — Choose the field data type (e.g., text, email, number, select, multiselect, boolean, date, etc.) to determine the input format.
• Alias — Provide a unique alias for the field; if omitted, it will be autogenerated from the label.
• Group — Assign the custom field to a group (default is 'core').
• Default Value — Specify a default value for the field if none is provided.
• Is Required — Flag to make the field mandatory.
• Is Publicly Updatable — Allow public API requests to update this field's value.
• Is Unique Identifier — Mark the field as a unique identifier in Mautic.
• Properties — For select or multiselect types, define the list of selectable options with labels and values.
• Additional Fields — Optional fields including description text, display order number, and whether the field is published and available for use.

Output shape

a JSON object representing the created field's details as returned by the Mautic API

The output returns the full created field data, including assigned IDs and configured attributes. Errors during creation will be surfaced as API errors.