> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Delete Custom Object Instances By External ID

> Delete an Intercom custom object record by its Intercom ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Delete an Intercom custom object record by its Intercom ID.

> [!NOTE]
>
> Tool ID: `intercom_delete_custom_object_instances_by_external_id`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_delete_custom_object_instances_by_external_id',
  {
    "custom_object_type_identifier": "example_123",
    "custom_object_instance_id": "custom_object_instance_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_delete_custom_object_instances_by_external_id --input '{
  "custom_object_type_identifier": "example_123",
  "custom_object_instance_id": "custom_object_instance_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "example",
    "id": "id_123",
    "deleted": true
  }
}
```

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

## Input reference

Delete a single Custom Object instance using the Intercom defined 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.custom_object_instance_id` | `string` | Yes | — | The Intercom defined id of the custom object instance |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Delete a single Custom Object instance using the Intercom defined id.",
    "properties": {
      "custom_object_type_identifier": {
        "type": "string",
        "description": "The unique identifier of the custom object type that defines the structure of the custom object instance."
      },
      "custom_object_instance_id": {
        "type": "string",
        "description": "The Intercom defined id of the custom object instance"
      }
    },
    "required": [
      "custom_object_type_identifier",
      "custom_object_instance_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "deleted custom object instance object",
        "properties": {
          "object": {
            "type": "string",
            "description": "The unique identifier of the Custom Object type that defines the structure of the Custom Object instance."
          },
          "id": {
            "type": "string",
            "description": "The Intercom defined id representing the Custom Object instance."
          },
          "deleted": {
            "type": "boolean",
            "description": "Whether the Custom Object instance is deleted or not."
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.