Intercom API (unofficial showcase)
DELETE/custom_object_instances/{custom_object_type_identifier}/{custom_object_instance_id}

Delete a custom object instance by ID

Deletes a custom object instance using its Intercom-defined ID. Use custom_object_type_identifier and custom_object_instance_id to identify the type and instance to delete.

3 parameters
custom_object_type_identifierstringrequired
The unique identifier of the custom object type that defines the instance structure.
custom_object_instance_idstringrequired
The Intercom-defined ID of the custom object instance to delete.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; use a supported version.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a deletion result containing the custom object type identifier, the instance ID, and whether the instance was deleted.
objectstringoptional
The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.
idstringoptional
The Intercom defined id representing the Custom Object instance.
deletedbooleanoptional
Whether the Custom Object instance is deleted or not.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the custom object type or instance is not found.

2 documented failures

  • not_found

    Object not found

  • data_invalid

    Integration not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the custom object type or instance is not found. The custom_object_type_identifier path parameter must identify the type, and custom_object_instance_id must identify the instance by its Intercom-defined ID.