Intercom: Update Ticket Type Attribute

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

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.

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

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.

{
  "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)

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

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

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation