Skip to content
Home/
REST API Reference
/
/
Custom Object Instance

Custom Object Instance

A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.

idstring

The Intercom defined id representing the custom object instance.

Example:16032025
external_idstring

The id you have defined for the custom object instance.

Example:"0001d1c1e65a7a19e9f59ae2"
external_created_atinteger or null, (date-time)

The time when the Custom Object instance was created in the external system it originated from.

Example:1571672154
external_updated_atinteger or null, (date-time)

The time when the Custom Object instance was last updated in the external system it originated from.

Example:1571672154
created_atinteger, (date-time)

The time the attribute was created as a UTC Unix timestamp

Example:1671028894
updated_atinteger, (date-time)

The time the attribute was last updated as a UTC Unix timestamp

Example:1671028894
typestring

The identifier of the custom object type that defines the structure of the custom object instance.

Example:"Order"
custom_attributesobject

The custom attributes you have set on the custom object instance.

{
  "id": 16032025,
  "external_id": "0001d1c1e65a7a19e9f59ae2",
  "external_created_at": 1571672154,
  "external_updated_at": 1571672154,
  "created_at": 1671028894,
  "updated_at": 1671028894,
  "type": "Order",
  "custom_attributes": {
    "property1": "string",
    "property2": "string"
  }
}