Custom Objects Guide 

What are Custom Objects?

Custom objects are extra data tables that let you link more information to a single contact.
Instead of storing everything against one contact adding more and more fields, custom objects allows one contact to have many related records.
For example, one person might make several enquiries. Each enquiry is stored as its own record, all linked to the same contact.
 This makes it easier to send emails, create audiences, and personalise messages using all the linked records.

Setting Up Custom Objects

1. Ask for custom objects to be turned on for your account (via a ticket). 
2. Go to settings and select "Add custom object." 
3. Give the custom object a name. 
4. Add the fields you need, making sure each one has the right type (text, date, integer, etc.). 
5. Publish the custom object

API Endpoints

API endpoints have been setup to allow for creation of objects and object fields as well as creating and updating custom object records.  Below are links through to the Swagger where the details for each call can be found:

• Create new objects
  1. https://api.data-crypt.com/index.html#/Schema/post_api_v1_3_schemas_contact_objects 
• Create new fields 
  1. https://api.data-crypt.com/index.html#/Schema/post_api_v1_3_schemas_contact_objects__objectId__fields 
• Create or update object records for a specific contact
  1. https://api.data-crypt.com/index.html#/Contacts/put_api_v1_3_contacts__id__objects__objectId___externalId 
• Create object records for a specific contact
  1. https://api.data-crypt.com/index.html#/Contacts/post_api_v1_3_contacts__id__objects__objectId_ 
• Update object records for a specific contact
  1. https://api.data-crypt.com/index.html#/Contacts/patch_api_v1_3_contacts__id__objects__objectId___externalId_ 

Helpful API Tips:

• Use the put request for all calls to update or create as this means additional calls don’t need to be made to check if the record already exists.
• Limited to one call per request, but can run 4 in parallel. 4 is the most optimal number to run in parallel. If you have 12 records, you would have 3 separate program calls to the same endpoint. 
• Ensure duplicates are all handled ahead of calling the API
• Use separate endpoints for create and update if logging creations and updates is needed. Using the Put request for create and update will only show it has been successful, and won’t show if that instance was created or whether it was updated.

Where Can You See Custom Object Data?

Custom object data can be found:

In contact search, as a clickable button in the first column. 

In the "Custom Objects" tab when viewing a contact (next to the "Activity" tab).

It is important to note that custom object data cannot be exported.

Using Custom Objects in Journeys

When creating a journey, select the "Custom Object" tab under journey type.
 Choose the custom object you want to use (only one per journey). 

Start Audience has two filters: 

1. Journey Context Filter – chooses which custom object record triggers the journey.
       Example: if a contact has two enquiries, both can enter separately.
2. Optional Filter Conditions – filters the contact record instead of the object record.
       Example: only include contacts with an active email address. 

Decisions have 2 different options: 

1. Standard Decision looks at the contact record (or all object records).
2. Custom Object Decision only checks the specific record that started the journey.
   1. Example: if an enquiry changes from "Active" to "Lost," the journey will pick that up.

Using Custom Objects in Email Templates

When creating a template, link it to a custom object by first selecting the ‘Connect this email to a data object’ button:

Next select the object from the drop down through the pop-up that appears.

This lets you personalise emails using:
Custom object fields
Standard contact fields
Contact extension fields
 

The personalisation comes from the specific record chosen in the journey context filter. 

Glossary

Custom Object: A table storing related data for one contact.
Custom Object Record: A single entry inside the custom object (e.g., one enquiry).
Custom Object Fields: Details inside a record (e.g., date, status, product name).
Journey Context Filter: Rules that pick the specific record to trigger a journey.
Optional Filter Conditions: Extra filters based on contact data.
Custom Object Decision: A choice in a journey that looks only at the specific object record.
Standard Decision: A choice in a journey that looks at the contact or all records.
Relational Database: A way of storing data where one contact can be linked to many records.