v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB

Custom Object Instances

Delete a Custom Object Instance by External ID

Delete a single Custom Object instance by external_id.

delete/custom_object_instances/{custom_object_type_identifier}

Query parameters

external_idstring required

The unique identifier for the instance in the external system it originated from.

Headers

Intercom-Version'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' | '2.11' | '2.12' | '2.13' | '2.14'

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

Example:2.14

Response

successful

objectstring

The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.

idstring

The Intercom defined id representing the Custom Object instance.

deletedboolean

Whether the Custom Object instance is deleted or not.

Example response

{
  "object": "Order",
  "id": "123",
  "deleted": true
}