Fireberry icon

Fireberry

Consume Fireberry API

Actions14

Create Field

AI-generated

Overview

This node operation creates a custom field in a specified object type within the Fireberry system. It supports various field types such as text, number, date, email, formula, lookup, picklist, and summary fields, allowing users to extend their data schema dynamically. This is useful for customizing data structures to fit specific business needs, such as adding a new contact phone number field or a calculated formula field for sales metrics.

Use Case Examples

  1. Create a new text field named 'pcfCustomerNote' with a label 'Customer Note' in the 'Contacts' object to store additional notes about customers.
  2. Add a number field with precision control to the 'Orders' object to track discount amounts.
  3. Create a lookup field in the 'Invoices' object that relates to the 'Customers' object for easy reference.

Properties

Name Meaning
Object Type Name or ID The object type in which the new field will be created. Can be selected from a list or specified by ID.
Field Type The type of field to create, such as text, number, date, formula, lookup, picklist, etc.
Field Name (API) The API name for the field, which must start with 'pcf' and be unique.
Label The display name for the field as it appears in the user interface.
Default Value Optional default value for new records, applicable to certain field types like text, number, date, etc.
Track Changes Whether to track changes to this field in system logs.
Auto Complete Whether to provide auto-complete suggestions based on previously used values, applicable to certain field types.
Max Length Maximum number of characters allowed for text-based fields.
Precision Number of decimal places to display for number fields.
Related Object Name or ID The object this field relates to, required for lookup and summary field types.
Picklist Values JSON array of picklist options with name and value properties, required for picklist fields.
Summary Type Type of summary calculation to perform, applicable to summary fields.
Summary Related Object Name or ID The related object to summarize, required for summary fields.
Summary Field Field to summarize, required for certain summary types like sum, avg, min, max.
Formula The formula expression to calculate the field value, required for formula fields.
Formula Field Type The data type that the formula will return, applicable to formula fields.
Formula Precision Number of decimal places for numeric formula results, applicable to formula fields returning numbers.

Output

JSON

  • json - The created field's details and metadata returned from the Fireberry API

Dependencies

  • Fireberry API
  • An API key credential for Fireberry authentication

Troubleshooting

  • Ensure the 'Field Name (API)' starts with 'pcf' and is unique to avoid API errors.
  • Verify that required fields like 'Object Type Name or ID', 'Field Type', 'Field Name (API)', and 'Label' are provided.
  • For lookup and summary fields, ensure the related object IDs are valid and accessible.
  • If using formula fields, validate the formula syntax to prevent calculation errors.
  • Batching options may affect execution speed and API rate limits; adjust batch size and interval accordingly.

Links

Discussion