Intercom: Delete Custom Object Instances By ID

Delete an Intercom custom object record by its external ID.

Tool ID: intercom_delete_custom_object_instances_by_id

Run this action

This action has conditional or dynamic inputs. A static example cannot describe these inputs reliably. Read the live contract before you execute this action:

deepline describe intercom_delete_custom_object_instances_by_id --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "object": "example",
    "id": "id_123",
    "deleted": true
  }
}

Use deepline describe intercom_delete_custom_object_instances_by_id --json for the latest machine-readable contract.

Input reference

Delete a single Custom Object instance by external_id.

Name	Type	Required	Default	Details
`payload.custom_object_type_identifier`	`string`	Yes	—	The unique identifier of the custom object type that defines the structure of the custom object instance.
`payload.external_id`	`string`	Yes	—	The unique identifier for the instance in the external system it originated from.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	deleted custom object instance object
`result.data.object`	`string`	No	—	The unique identifier of the Custom Object type that defines the structure of the Custom Object instance.
`result.data.id`	`string`	No	—	The Intercom defined id representing the Custom Object instance.
`result.data.deleted`	`boolean`	No	—	Whether the Custom Object instance is deleted or not.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation