Home
/
REST API Reference
/
Custom Object Instances
/
Create or Update a Custom Object Instance

Create or Update a Custom Object Instance

Create or update a custom object instance

SecurityHTTP: bearerAuth
Request
path Parameters
custom_object_type_identifier
required
string

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

Example: Order
header Parameters
Intercom-Version
string (intercom_version)
Default: Unstable

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: Unstable
Request Body schema: application/json
external_id
string

A unique identifier for the Custom Object instance in the external system it originated from.

external_created_at
integer or null <date-time>

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

external_updated_at
integer or null <date-time>

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

custom_attributes
object or null

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

post
/custom_object_instances/{custom_object_type_identifier}
Request samples
application/json
{
"external_id": "123",
"external_created_at": 1392036272,
"external_updated_at": 1392036272
}
Responses

200

successful

Response Schema: application/json
id
string

The Intercom defined id representing the custom object instance.

external_id
string

The id you have defined for the custom object instance.

type
string

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

object

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

401

Unauthorized

Response samples
application/json
{
"id": "1",
"type": "object_type_identifier_1",
"custom_attributes": { },
"external_id": "123",
"external_created_at": 1392036272,
"external_updated_at": 1392036272,
"created_at": 1713520876,
"updated_at": 1713520876
}