Home
/
REST API Reference
/
Ticket Type Attributes
/
Create a new attribute for a ticket type

Create a new attribute for a ticket type

You can create a new attribute for a ticket type.

SecurityHTTP: bearerAuth
Request
path Parameters
ticket_type_id
required
string

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

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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

Enum: "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" "Unstable"
Example: 2.10
Request Body schema: application/json
name
required
string

The name of the ticket type attribute

description
required
string

The description of the attribute presented to the teammate or contact

data_type
required
string

The data type of the attribute

Enum: "string" "list" "integer" "decimal" "boolean" "datetime" "files"
required_to_create
boolean
Default: false

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

required_to_create_for_contacts
boolean
Default: false

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

visible_on_create
boolean
Default: true

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

visible_to_contacts
boolean
Default: true

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

multiline
boolean

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

list_items
string

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

allow_multiple_values
boolean

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

post
/ticket_types/{ticket_type_id}/attributes
Request samples
application/json
{
"name": "Attribute Title",
"description": "Attribute Description",
"data_type": "string",
"required_to_create": false
}
Responses

200

Ticket Type Attribute created

Response Schema: application/json
type
string

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

id
string

The id representing the ticket type attribute.

workspace_id
string

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

name
string

The name of the ticket type attribute

description
string

The description of the ticket type attribute

data_type
string

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

input_options
object

Input options for the attribute

order
integer

The order of the attribute against other attributes

required_to_create
boolean
Default: false

Whether the attribute is required or not for teammates.

required_to_create_for_contacts
boolean
Default: false

Whether the attribute is required or not for contacts.

visible_on_create
boolean
Default: true

Whether the attribute is visible or not to teammates.

visible_to_contacts
boolean
Default: true

Whether the attribute is visible or not to contacts.

default
boolean

Whether the attribute is built in or not.

ticket_type_id
integer

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

archived
boolean

Whether the ticket type attribute is archived or not.

created_at
integer <timestamp>

The date and time the ticket type attribute was created.

updated_at
integer <timestamp>

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

401

Unauthorized

Response samples
application/json
{
"type": "ticket_type_attribute",
"id": "2440",
"workspace_id": "this_is_an_id578_that_should_be_at_least_",
"name": "Attribute Title",
"description": "Attribute Description",
"data_type": "string",
"input_options": {
"multiline": false
},
"order": 2,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": true,
"default": false,
"ticket_type_id": 877,
"archived": false,
"created_at": 1712223120,
"updated_at": 1712223120
}