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

Create a ticket type attribute

Creates an attribute for a ticket type to define a data field captured on tickets. Supply name, description, and data_type; data_type must be one of the supported values. Use the remaining fields to configure the attribute's visibility and input options.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 10 body fields
ticket_type_idstringrequired
The unique identifier of the ticket type to add the attribute to.
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 configuration. Include name, description, and data_type.

namestringrequired
The name of the ticket type attribute
descriptionstringrequired
The description of the attribute presented to the teammate or contact
data_typestringrequired
The data type of the attribute
Allowed:stringlistintegerdecimalbooleandatetimefiles
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)

2 status codes
200Returns the created ticket type attribute, including its identifier, data type, input options, and 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. name, description, and data_type are required, and data_type must be one of: string, list, integer, decimal, boolean, datetime, or files. The ticket_type_id path parameter identifies the ticket type to receive the attribute.