Settings
/
Management
/
Custom fields
Last updated

Custom fields

This topic describes how to add custom fields using the Rebilly UI. To add custom fields using the Rebilly API, see the Custom fields operations.

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. Depending on the resource on which the custom field is added, it will be available in all related forms and also as a filter in data table segments.

Example: A custom field called 'Preferred contact method' is added to the customer resource. It has two allowed values, which are 'email' and 'phone'. When new customers are added, they will be prompted to provide this information. Alternatively, if the customer is manually added, a field for this value is provided. The custom field is also provided as a filter in data tables.

Create custom fields

Use this process to add custom fields.

  1. In the left navigation bar, click Settings .
  2. In the Management section, click Custom fields.
  3. Click Create custom field.
  4. In the Resource dropdown, select the resource you want to associate with the custom field.
    For example, if you want to add a preferred contact method field to customers, select the 'Customers' resource.
  5. In the Type dropdown, select the format of the data.
    For example, if you want to store preferred contact information that contains alphanumeric data, select 'String'.
  6. In the Label field, enter a name for the custom field.
  7. In the Description field, enter a description for the custom field.
  8. Optionally, to restrict the available input values, select the Apply value restrictions checkbox and enter the allowed values.
    For example, for the preferred contact method, you may want to add 'Email' or 'Phone'.
    Note: Restrictions are only available for array and string data types.
  9. Use the Preview section to visualize how the custom field is displayed.
  10. Click Save custom field.

Edit custom fields

This process describes how to edit custom fields.

  1. In the left navigation bar, click Settings .
  2. In the Management section, click Custom fields.
  3. Select a custom field.
  4. Edit the custom field, then click Save custom field.