> ## 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 Update Data Attribute: Inputs, Cost & CLI Example

> Update a data attribute. Intercom Intercom Update Data Attribute docs include request fields, response shape, pricing notes, and Deepline CLI examples.

## 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_update_data_attribute:{"data_attribute_id":"{{data_attribute_id}}"}' --json
```

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

## Input Schema

| Name                         | Type      | Required | Default | Description                                                   |
| ---------------------------- | --------- | -------- | ------- | ------------------------------------------------------------- |
| `payload.data_attribute_id`  | `integer` | Yes      |         | The data attribute id                                         |
| `payload.archived`           | `boolean` | No       |         | Whether the attribute is to be archived or not.               |
| `payload.description`        | `string`  | No       |         | The readable description you see in the UI for the attribute. |
| `payload.messenger_writable` | `boolean` | No       |         | Can this attribute be updated by the Messenger                |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "You can update a data attribute. > 🚧 Updating the data type is not possible > > It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.",
    "properties": {
      "data_attribute_id": {
        "type": "integer",
        "description": "The data attribute id"
      },
      "archived": {
        "type": "boolean",
        "description": "Whether the attribute is to be archived or not."
      },
      "description": {
        "type": "string",
        "description": "The readable description you see in the UI for the attribute."
      },
      "messenger_writable": {
        "type": "boolean",
        "description": "Can this attribute be updated by the Messenger"
      }
    },
    "required": [
      "data_attribute_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                                                                                                                                                                                                                                                                      |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `result.data` | `object` | Yes      |         | Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive 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",
        "description": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.",
        "properties": {
          "type": {
            "type": "string",
            "description": "Value is `data_attribute`.",
            "enum": [
              "data_attribute"
            ]
          },
          "id": {
            "type": "integer",
            "description": "The unique identifier for the data attribute which is given by Intercom. Only available for custom attributes."
          },
          "model": {
            "type": "string",
            "description": "Value is `contact` for user/lead attributes and `company` for company attributes.",
            "enum": [
              "contact",
              "company"
            ]
          },
          "name": {
            "type": "string",
            "description": "Name of the attribute."
          },
          "full_name": {
            "type": "string",
            "description": "Full name of the attribute. Should match the name unless it's a nested attribute. We can split full_name on `.` to access nested user object values."
          },
          "label": {
            "type": "string",
            "description": "Readable name of the attribute (i.e. name you see in the UI)"
          },
          "description": {
            "type": "string",
            "description": "Readable description of the attribute."
          },
          "data_type": {
            "type": "string",
            "description": "The data type of the attribute.",
            "enum": [
              "string",
              "integer",
              "float",
              "boolean",
              "date"
            ]
          },
          "options": {
            "type": "array",
            "description": "List of predefined options for attribute value.",
            "items": {
              "type": "string"
            }
          },
          "api_writable": {
            "type": "boolean",
            "description": "Can this attribute be updated through API"
          },
          "messenger_writable": {
            "type": "boolean",
            "description": "Can this attribute be updated by the Messenger"
          },
          "ui_writable": {
            "type": "boolean",
            "description": "Can this attribute be updated in the UI"
          },
          "custom": {
            "type": "boolean",
            "description": "Set to true if this is a CDA"
          },
          "archived": {
            "type": "boolean",
            "description": "Is this attribute archived. (Only applicable to CDAs)"
          },
          "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"
          },
          "admin_id": {
            "type": "string",
            "description": "Teammate who created the attribute. Only applicable to CDAs"
          }
        },
        "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_update_data_attribute --payload '{
  "data_attribute_id": "integer"
}' --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`.