Skip to content
Home/
REST API Reference
/
/
Create Or Update Custom O...

Create Or Update Custom Object Instance Request Payload

Payload to create or update a Custom Object instance

external_idstring

A unique identifier for the Custom Object instance in the external system it originated from. The value reference_not_found is reserved and is rejected with a 400. Omitting this field creates a new instance on every request instead of updating an existing one.

external_created_atinteger or null, (date-time)

The time when the Custom Object instance was created in the external system it originated from. A value that cannot be read as a time is stored as null rather than rejected.

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. A value that cannot be read as a time is stored as null rather than rejected.

Example:1571672154
custom_attributesobject or null

The custom attributes which are set for the Custom Object instance.

Each value must match the type of the attribute it is set on: a string, integer, number or boolean, a Unix timestamp or date string for a datetime attribute, or null to clear the attribute. A list attribute takes the label or id of one of its options; a value that matches no option clears the attribute rather than being rejected. A reference attribute takes the Intercom id of the record it points at, or an array of ids for a reference to several records; an id that matches no record is skipped.

Example:
{
  "order_number": "ORDER-12345",
  "total_amount": 99.99
}
{
  "external_id": "string",
  "external_created_at": 1571672154,
  "external_updated_at": 1571672154,
  "custom_attributes": {
    "order_number": "ORDER-12345",
    "total_amount": 99.99
  }
}