Intercom API (unofficial showcase)
PUT/ticket_types/{ticket_type_id}/attributes/{attribute_id}

Update a ticket type attribute

Updates the configuration of an existing ticket type attribute. Use the ticket_type_id and attribute_id path parameters to identify the attribute; provide only the fields you want to change.

3 parameters · 10 body fields
ticket_type_idstringrequired
The unique identifier of the ticket type that contains the attribute.
attribute_idstringrequired
The unique identifier of the ticket type attribute to update.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

The ticket type attribute fields to update. All fields are optional.

namestringoptional
The name of the ticket type attribute
descriptionstringoptional
The description of the attribute presented to the teammate or contact
required_to_createbooleanoptional
Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.
Default:false
required_to_create_for_contactsbooleanoptional
Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.
Default:false
visible_on_createbooleanoptional
Whether the attribute is visible to teammates when creating a ticket in Inbox.
Default:true
visible_to_contactsbooleanoptional
Whether the attribute is visible to contacts when creating a ticket in Messenger.
Default:true
multilinebooleanoptional
Whether the attribute allows multiple lines of text (only applicable to string attributes)
list_itemsstringoptional
A comma delimited list of items for the attribute value (only applicable to list attributes)
allow_multiple_valuesbooleanoptional
Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)
archivedbooleanoptional
Whether the attribute should be archived and not shown during creation of the ticket (it will still be present on previously created tickets)

2 status codes
200Returns the updated ticket type attribute, including its current configuration.
typestringoptional
String representing the object's type. Always has the value `ticket_type_attribute`.
idstringoptional
The id representing the ticket type attribute.
workspace_idstringoptional
The id of the workspace that the ticket type attribute belongs to.
namestringoptional
The name of the ticket type attribute
descriptionstringoptional
The description of the ticket type attribute
data_typestringoptional
The type of the data attribute (allowed values: "string list integer decimal boolean datetime files")
input_optionsobjectoptional
Input options for the attribute
orderintegeroptional
The order of the attribute against other attributes
required_to_createbooleanoptional
Whether the attribute is required or not for teammates.
Default:false
required_to_create_for_contactsbooleanoptional
Whether the attribute is required or not for contacts.
Default:false
visible_on_createbooleanoptional
Whether the attribute is visible or not to teammates.
Default:true
visible_to_contactsbooleanoptional
Whether the attribute is visible or not to contacts.
Default:true
defaultbooleanoptional
Whether the attribute is built in or not.
ticket_type_idintegeroptional
The id of the ticket type that the attribute belongs to.
archivedbooleanoptional
Whether the ticket type attribute is archived or not.
created_atintegeroptional
The date and time the ticket type attribute was created.
updated_atintegeroptional
The date and time the ticket type attribute was last updated.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. The ticket_type_id path parameter identifies the ticket type, and the attribute_id path parameter identifies the attribute to update. All body fields are optional; set archived to control whether the attribute is shown during ticket creation.