> ## 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 Create Custom Object Instances: Inputs, Cost &

> Create or Update a Custom Object Instance. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_create_custom_object_instances:{"custom_object_type_identifier":"{{custom_object_type_identifier}}"}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                                    | Type      | Required | Default | Description                                                                                               |
| --------------------------------------- | --------- | -------- | ------- | --------------------------------------------------------------------------------------------------------- |
| `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`  | No       |         | A unique identifier for the Custom Object instance in the external system it originated from.             |
| `payload.external_created_at`           | `integer` | No       |         | The time when the Custom Object instance was created in the external system it originated from.           |
| `payload.external_updated_at`           | `integer` | No       |         | The time when the Custom Object instance was last updated in the external system it originated from.      |
| `payload.custom_attributes`             | `record`  | No       |         | The custom attributes which are set for the Custom Object instance.                                       |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Payload to create or update a Custom Object instance",
    "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."
      },
      "external_id": {
        "type": "string",
        "description": "A unique identifier for the Custom Object instance in the external system it originated from."
      },
      "external_created_at": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The time when the Custom Object instance was created in the external system it originated from.",
        "format": "date-time"
      },
      "external_updated_at": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The time when the Custom Object instance was last updated in the external system it originated from.",
        "format": "date-time"
      },
      "custom_attributes": {
        "type": [
          "object",
          "null"
        ],
        "description": "The custom attributes which are set for the Custom Object instance.",
        "additionalProperties": {
          "type": "string"
        }
      }
    },
    "required": [
      "custom_object_type_identifier"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                                                                                                                                                                                                                                                                                     |
| ------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes      |         | A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes. |
| `result.meta` | `object` | No       |         | Additional response metadata (status, paging).                                                                                                                                                                                                                                                                  |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The Intercom defined id representing the custom object instance."
          },
          "external_id": {
            "type": "string",
            "description": "The id you have defined for the custom object instance."
          },
          "external_created_at": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The time when the Custom Object instance was created in the external system it originated from.",
            "format": "date-time"
          },
          "external_updated_at": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The time when the Custom Object instance was last updated in the external system it originated from.",
            "format": "date-time"
          },
          "created_at": {
            "type": "integer",
            "description": "The time the attribute was created as a UTC Unix timestamp",
            "format": "date-time"
          },
          "updated_at": {
            "type": "integer",
            "description": "The time the attribute was last updated as a UTC Unix timestamp",
            "format": "date-time"
          },
          "type": {
            "type": "string",
            "description": "The identifier of the custom object type that defines the structure of the custom object instance."
          },
          "custom_attributes": {
            "type": "object",
            "description": "The custom attributes you have set on the custom object instance.",
            "additionalProperties": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute intercom_create_custom_object_instances --payload '{
  "custom_object_type_identifier": "string"
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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