Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Ticket Type Attributes

Update an existing attribute for a ticket type

You can update an existing attribute for a ticket type.

put/ticket_types/{ticket_type_id}/attributes/{attribute_id}

Path parameters

ticket_type_idstring required

The unique identifier for the ticket type which is given by Intercom.

attribute_idstring required

The unique identifier for the ticket type attribute which is given by Intercom.

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

namestring

The name of the ticket type attribute

descriptionstring

The description of the attribute presented to the teammate or contact

required_to_createboolean

Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.

required_to_create_for_contactsboolean

Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.

visible_on_createboolean

Whether the attribute is visible to teammates when creating a ticket in Inbox.

visible_to_contactsboolean

Whether the attribute is visible to contacts when creating a ticket in Messenger.

multilineboolean

Whether the attribute allows multiple lines of text (only applicable to string attributes)

list_itemsstring

A comma delimited list of items for the attribute value (only applicable to list attributes)

allow_multiple_valuesboolean

Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)

archivedboolean

Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)

Example request

{
  "name": "Bug Priority",
  "description": "Priority level of the bug",
  "visible_on_create": true,
  "visible_to_contacts": true,
  "list_items": "Low Priority,Medium Priority,High Priority"
}

Response

Ticket Type Attribute updated

typestring

String representing the object's type. Always has the value ticket_type_attribute.

idstring

The id representing the ticket type attribute.

workspace_idstring

The id of the workspace that the ticket type attribute belongs to.

namestring

The name of the ticket type attribute

descriptionstring

The description of the ticket type attribute

data_typestring

The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")

input_optionsobject

Input options for the attribute

orderinteger

The order of the attribute against other attributes

required_to_createboolean

Whether the attribute is required or not for teammates.

required_to_create_for_contactsboolean

Whether the attribute is required or not for contacts.

visible_on_createboolean

Whether the attribute is visible or not to teammates.

visible_to_contactsboolean

Whether the attribute is visible or not to contacts.

defaultboolean

Whether the attribute is built in or not.

ticket_type_idinteger

The id of the ticket type that the attribute belongs to.

archivedboolean

Whether the ticket type attribute is archived or not.

created_atinteger

The date and time the ticket type attribute was created.

updated_atinteger

The date and time the ticket type attribute was last updated.

Example response

{
  "type": "ticket_type_attribute",
  "id": "1",
  "workspace_id": "ecahpwf5",
  "name": "Title",
  "description": "Bug title.",
  "data_type": "string",
  "order": 1,
  "default": true,
  "ticket_type_id": 42
}