Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.
Home
/
REST API Reference
/
Ticket Type Attributes

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Create a new attribute for a ticket type

Request

You can create a new attribute for a ticket type.

Path
ticket_type_idstringrequired

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

Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

Bodyapplication/json
namestringrequired

The name of the ticket type attribute

Example:

"Bug Priority"

descriptionstringrequired

The description of the attribute presented to the teammate or contact

Example:

"Priority level of the bug"

data_typestringrequired

The data type of the attribute

Enum"string""list""integer""decimal""boolean""datetime""files"
Example:

"string"

required_to_createboolean

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

Default false
Example:

false

required_to_create_for_contactsboolean

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

Default false
Example:

false

visible_on_createboolean

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

Default true
Example:

true

visible_to_contactsboolean

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

Default true
Example:

true

multilineboolean

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

Example:

false

list_itemsstring

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

Example:

"Low Priority,Medium Priority,High Priority"

allow_multiple_valuesboolean

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

Example:

false

curl -i -X POST \
  'https://api.intercom.io/ticket_types/{ticket_type_id}/attributes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.11' \
  -d '{
    "name": "Bug Priority",
    "description": "Priority level of the bug",
    "data_type": "string",
    "required_to_create": false,
    "required_to_create_for_contacts": false,
    "visible_on_create": true,
    "visible_to_contacts": true,
    "multiline": false,
    "list_items": "Low Priority,Medium Priority,High Priority",
    "allow_multiple_values": false
  }'
Experience it firsthand in the API Explorer!

Responses

Ticket Type Attribute created

Bodyapplication/json
typestring

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

Example:

"ticket_type_attribute"

idstring

The id representing the ticket type attribute.

Example:

"1"

workspace_idstring

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

Example:

"ecahpwf5"

namestring

The name of the ticket type attribute

Example:

"Title"

descriptionstring

The description of the ticket type attribute

Example:

"Bug title."

data_typestring

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

Example:

"string"

input_optionsobject

Input options for the attribute

Example:

"multiline: true"

orderinteger

The order of the attribute against other attributes

Example:

1

required_to_createboolean

Whether the attribute is required or not for teammates.

Default false
Example:

false

required_to_create_for_contactsboolean

Whether the attribute is required or not for contacts.

Default false
Example:

false

visible_on_createboolean

Whether the attribute is visible or not to teammates.

Default true
Example:

false

visible_to_contactsboolean

Whether the attribute is visible or not to contacts.

Default true
Example:

false

defaultboolean

Whether the attribute is built in or not.

Example:

true

ticket_type_idinteger

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

Example:

42

archivedboolean

Whether the ticket type attribute is archived or not.

Example:

false

created_atinteger(timestamp)

The date and time the ticket type attribute was created.

updated_atinteger(timestamp)

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

Response
application/json
{
  "type": "ticket_type_attribute",
  "id": "1",
  "workspace_id": "ecahpwf5",
  "name": "Title",
  "description": "Bug title.",
  "data_type": "string",
  "input_options": "multiline: true",
  "order": 1,
  "required_to_create": false,
  "required_to_create_for_contacts": false,
  "visible_on_create": false,
  "visible_to_contacts": false,
  "default": true,
  "ticket_type_id": 42,
  "archived": false,
  "created_at": 0,
  "updated_at": 0
}

Update an existing attribute for a ticket type

Request

You can update an existing attribute for a ticket type.

Path
ticket_type_idstringrequired

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

idstringrequired

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

Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

Bodyapplication/json
namestring

The name of the ticket type attribute

Example:

"Bug Priority"

descriptionstring

The description of the attribute presented to the teammate or contact

Example:

"Priority level of the bug"

required_to_createboolean

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

Default false
Example:

false

required_to_create_for_contactsboolean

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

Default false
Example:

false

visible_on_createboolean

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

Default true
Example:

true

visible_to_contactsboolean

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

Default true
Example:

true

multilineboolean

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

Example:

false

list_itemsstring

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

Example:

"Low Priority,Medium Priority,High Priority"

allow_multiple_valuesboolean

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

Example:

false

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:

false

curl -i -X PUT \
  'https://api.intercom.io/ticket_types/{ticket_type_id}/attributes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.11' \
  -d '{
    "name": "Bug Priority",
    "description": "Priority level of the bug",
    "required_to_create": false,
    "required_to_create_for_contacts": false,
    "visible_on_create": true,
    "visible_to_contacts": true,
    "multiline": false,
    "list_items": "Low Priority,Medium Priority,High Priority",
    "allow_multiple_values": false,
    "archived": false
  }'
Experience it firsthand in the API Explorer!

Responses

Ticket Type Attribute updated

Bodyapplication/json
typestring

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

Example:

"ticket_type_attribute"

idstring

The id representing the ticket type attribute.

Example:

"1"

workspace_idstring

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

Example:

"ecahpwf5"

namestring

The name of the ticket type attribute

Example:

"Title"

descriptionstring

The description of the ticket type attribute

Example:

"Bug title."

data_typestring

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

Example:

"string"

input_optionsobject

Input options for the attribute

Example:

"multiline: true"

orderinteger

The order of the attribute against other attributes

Example:

1

required_to_createboolean

Whether the attribute is required or not for teammates.

Default false
Example:

false

required_to_create_for_contactsboolean

Whether the attribute is required or not for contacts.

Default false
Example:

false

visible_on_createboolean

Whether the attribute is visible or not to teammates.

Default true
Example:

false

visible_to_contactsboolean

Whether the attribute is visible or not to contacts.

Default true
Example:

false

defaultboolean

Whether the attribute is built in or not.

Example:

true

ticket_type_idinteger

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

Example:

42

archivedboolean

Whether the ticket type attribute is archived or not.

Example:

false

created_atinteger(timestamp)

The date and time the ticket type attribute was created.

updated_atinteger(timestamp)

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

Response
application/json
{
  "type": "ticket_type_attribute",
  "id": "1",
  "workspace_id": "ecahpwf5",
  "name": "Title",
  "description": "Bug title.",
  "data_type": "string",
  "input_options": "multiline: true",
  "order": 1,
  "required_to_create": false,
  "required_to_create_for_contacts": false,
  "visible_on_create": false,
  "visible_to_contacts": false,
  "default": true,
  "ticket_type_id": 42,
  "archived": false,
  "created_at": 0,
  "updated_at": 0
}

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models