Interacting with Custom Objects in CRM Hub (w/ examples)

How to use the Custom Object Methods provided via the Cloud Elements CRM Hub API (w/ Examples).

Most CRM systems have the ability to create Custom Objects. Thus, If your application needs to interact with your customer’s SugarCRM and/or Salesforce instance(s), it is very likely that your application will need to interact with the data contained within custom objects.

The Cloud Elements CRM Hub provides methods for operations on the standard CRM objects (accounts, contacts, leads, & opportunities), but what about interacting with custom objects?  The answer is yes, absolutely.  Here is how:

The CRM Hub’s API allows you to access custom objects in your CRM using the object name:

Lets explore each with examples using a simple custom object named House__c which has already been created in  Here are the details:

  1. Custom Object Name = House

    1. Standard Fields:

      1. Field Label = House Name

      2. Field Name = House

    2. API Name = House__c  (Note:  Salesforce convention)

  2. Custom Field Label = House Value

    1. API Name = House_Value__c

First, lets find out if any object instances have been created that are based on our House custom object via the /objects/{objectName} method:

it returns information show that there are two instances Vail House and Breckenridge House:


Creating a new instance of the House__c object using a POST to  /crm/objects/{objectName}:

Produces a new instance of the House__c object named WinterPark House:

Lets retrieve the instance that we just created (hint: use the id returned from POST /crm/{objectName}, or from get /crm/{objectName}/{id}

here is the retrieved information:

 Lets correct the name of the object via a PATCH /crm/{objectName}/{id} method:

Which is validated by:



Now, lets delete the Winter Park House object instance via DELETE /crm/{objectName}/{id}:

and, yep, the object has been deleted:


There you have it, with the CRM Hub, you can easily have your application interact with your Customer’s custom objects.

Next Up: How to transform custom object data fields into a common canonical format using the transformation API.


Was this article helpful?
2 out of 2 found this helpful
Have more questions? Submit a request