API v1 Reference

Custom Objects

Custom Objects are custom data tables that you can create in NeonCRM.

These are useful for storing data in NeonCRM that doesn’t fit any of the existing standard data types. We provide two sets of API methods for interacting with custom objects: Object methods and Object Record methods.

Custom Object Methods

We provide a set of API methods to administrate custom object data types. We expose subset of the functionality found in the NeonCRM system user interface. Some configuration options found in the UI are not available through the API. Some of the tools necessary to build custom objects (such as the Lookup Relation Filter Builder or Validation Rule Formula Builder) must be used first from the NeonCRM interface, the results of which would then be translated to your API code.

From a practical standpoint, it makes the most sense to use NeonCRM’s system user interface to build custom objects instead of the API. For scenarios where you are building a custom object for a single NeonCRM customer this is the optimal solution because it provides more immediate feedback, more options, and is easier to troubleshoot.

If you are a software developer building some sort of custom object tool (such as a software integration) and you expect your custom object to be used for more than one NeonCRM system, you can write a script that uses the API to create your objects automatically.

The standard workflow for building custom objects through the API is to first build a prototype for your custom object using the NeonCRM system user interface. Take detailed notes on all objects, fields, and validation rules you create. Once you have done that, your script should:

  1. Create your custom objects.
  2. Create fields for each of your custom objects.
  3. Create validation rules for each of your custom objects.
  4. Create layouts to control how your custom object records are displayed to NeonCRM system users.

Custom Object Record Methods

Once custom objects have been created in a NeonCRM system, you can use the Object Record API methods to Create, Retrieve, Update, Delete, and List records for a given Custom Object.