Delete a Custom Object Instance

REST API Reference

Delete a single Custom Object instance using the Intercom defined id.

SecurityHTTP: bearerAuth

Request

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
id required	string The Intercom defined id of the custom object instance

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

delete

/custom_object_instances/{custom_object_type_identifier}/{id}

Request samples

Responses

200

successful

object	string The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.
id	string The Intercom defined id representing the Custom Object instance.
deleted	boolean Whether the Custom Object instance is deleted or not.

401

Unauthorized

Response samples
200
401
application/json
successful
{
"id": "5",
"object": "object_type_identifier_8",
"deleted": true
}