> ## 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 Ticket Type Attribute

> Update a field on an Intercom ticket type, such as its name or whether it is required. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Update a field on an Intercom ticket type, such as its name or whether it is required.

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

## 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_update_ticket_type_attribute',
  {
    "ticket_type_id": "ticket_type_123",
    "attribute_id": "attribute_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_update_ticket_type_attribute --input '{
  "ticket_type_id": "ticket_type_123",
  "attribute_id": "attribute_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": {
    "type": "example",
    "id": "id_123",
    "workspace_id": "workspace_123"
  }
}
```

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

## Input reference

You can update a Ticket Type Attribute

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ticket_type_id` | `string` | Yes | — | The unique identifier for the ticket type which is given by Intercom. |
| `payload.attribute_id` | `string` | Yes | — | The unique identifier for the ticket type attribute which is given by Intercom. |
| `payload.name` | `string` | No | — | The name of the ticket type attribute |
| `payload.description` | `string` | No | — | The description of the attribute presented to the teammate or contact |
| `payload.required_to_create` | `boolean` | No | `false` | Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox. |
| `payload.required_to_create_for_contacts` | `boolean` | No | `false` | Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger. |
| `payload.visible_on_create` | `boolean` | No | `true` | Whether the attribute is visible to teammates when creating a ticket in Inbox. |
| `payload.visible_to_contacts` | `boolean` | No | `true` | Whether the attribute is visible to contacts when creating a ticket in Messenger. |
| `payload.multiline` | `boolean` | No | — | Whether the attribute allows multiple lines of text (only applicable to string attributes) |
| `payload.list_items` | `string` | No | — | A comma delimited list of items for the attribute value (only applicable to list attributes) |
| `payload.allow_multiple_values` | `boolean` | No | — | Whether the attribute allows multiple files to be attached to it (only applicable to file attributes) |
| `payload.archived` | `boolean` | No | — | Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets) |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can update a Ticket Type Attribute",
    "properties": {
      "ticket_type_id": {
        "type": "string",
        "description": "The unique identifier for the ticket type which is given by Intercom."
      },
      "attribute_id": {
        "type": "string",
        "description": "The unique identifier for the ticket type attribute which is given by Intercom."
      },
      "name": {
        "type": "string",
        "description": "The name of the ticket type attribute"
      },
      "description": {
        "type": "string",
        "description": "The description of the attribute presented to the teammate or contact"
      },
      "required_to_create": {
        "type": "boolean",
        "description": "Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.",
        "default": false
      },
      "required_to_create_for_contacts": {
        "type": "boolean",
        "description": "Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.",
        "default": false
      },
      "visible_on_create": {
        "type": "boolean",
        "description": "Whether the attribute is visible to teammates when creating a ticket in Inbox.",
        "default": true
      },
      "visible_to_contacts": {
        "type": "boolean",
        "description": "Whether the attribute is visible to contacts when creating a ticket in Messenger.",
        "default": true
      },
      "multiline": {
        "type": "boolean",
        "description": "Whether the attribute allows multiple lines of text (only applicable to string attributes)"
      },
      "list_items": {
        "type": "string",
        "description": "A comma delimited list of items for the attribute value (only applicable to list attributes)"
      },
      "allow_multiple_values": {
        "type": "boolean",
        "description": "Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)"
      },
      "archived": {
        "type": "boolean",
        "description": "Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)"
      }
    },
    "required": [
      "ticket_type_id",
      "attribute_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Ticket type attribute, used to define each data field to be captured in a ticket. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `ticket_type_attribute`. |
| `result.data.id` | `string` | No | — | The id representing the ticket type attribute. |
| `result.data.workspace_id` | `string` | No | — | The id of the workspace that the ticket type attribute belongs to. |
| `result.data.name` | `string` | No | — | The name of the ticket type attribute |
| `result.data.description` | `string` | No | — | The description of the ticket type attribute |
| `result.data.data_type` | `string` | No | — | The type of the data attribute (allowed values: "string list integer decimal boolean datetime files") |
| `result.data.input_options` | `record` | No | — | Input options for the attribute |
| `result.data.order` | `integer` | No | — | The order of the attribute against other attributes |
| `result.data.required_to_create` | `boolean` | No | `false` | Whether the attribute is required or not for teammates. |
| `result.data.required_to_create_for_contacts` | `boolean` | No | `false` | Whether the attribute is required or not for contacts. |
| `result.data.visible_on_create` | `boolean` | No | `true` | Whether the attribute is visible or not to teammates. |
| `result.data.visible_to_contacts` | `boolean` | No | `true` | Whether the attribute is visible or not to contacts. |
| `result.data.default` | `boolean` | No | — | Whether the attribute is built in or not. |
| `result.data.ticket_type_id` | `integer` | No | — | The id of the ticket type that the attribute belongs to. |
| `result.data.archived` | `boolean` | No | — | Whether the ticket type attribute is archived or not. |
| `result.data.created_at` | `integer` | No | — | The date and time the ticket type attribute was created. Format: `timestamp`. |
| `result.data.updated_at` | `integer` | No | — | The date and time the ticket type attribute was last updated. Format: `timestamp`. |
| `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",
          "null"
        ],
        "description": "Ticket type attribute, used to define each data field to be captured in a ticket.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `ticket_type_attribute`."
          },
          "id": {
            "type": "string",
            "description": "The id representing the ticket type attribute."
          },
          "workspace_id": {
            "type": "string",
            "description": "The id of the workspace that the ticket type attribute belongs to."
          },
          "name": {
            "type": "string",
            "description": "The name of the ticket type attribute"
          },
          "description": {
            "type": "string",
            "description": "The description of the ticket type attribute"
          },
          "data_type": {
            "type": "string",
            "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")"
          },
          "input_options": {
            "type": "object",
            "description": "Input options for the attribute"
          },
          "order": {
            "type": "integer",
            "description": "The order of the attribute against other attributes"
          },
          "required_to_create": {
            "type": "boolean",
            "description": "Whether the attribute is required or not for teammates.",
            "default": false
          },
          "required_to_create_for_contacts": {
            "type": "boolean",
            "description": "Whether the attribute is required or not for contacts.",
            "default": false
          },
          "visible_on_create": {
            "type": "boolean",
            "description": "Whether the attribute is visible or not to teammates.",
            "default": true
          },
          "visible_to_contacts": {
            "type": "boolean",
            "description": "Whether the attribute is visible or not to contacts.",
            "default": true
          },
          "default": {
            "type": "boolean",
            "description": "Whether the attribute is built in or not."
          },
          "ticket_type_id": {
            "type": "integer",
            "description": "The id of the ticket type that the attribute belongs to."
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the ticket type attribute is archived or not."
          },
          "created_at": {
            "type": "integer",
            "description": "The date and time the ticket type attribute was created.",
            "format": "timestamp"
          },
          "updated_at": {
            "type": "integer",
            "description": "The date and time the ticket type attribute was last updated.",
            "format": "timestamp"
          }
        },
        "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.