Home
/
REST API Reference
/
Models
/
Ticket Type Attributes

Intercom API (2.9)

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

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Ticket Type Attribute

Ticket type attribute, used to define each data field to be captured in a ticket.

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.

{
  "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 Type Attributes

A list of attributes associated with a given ticket type.

typestring

String representing the object's type. Always has the value ticket_type_attributes.list.

ticket_type_attributesArray of objects or null(Ticket Type Attribute)

A list of ticket type attributes associated with a given ticket type.

{
  "type": "string",
  "ticket_type_attributes": [
    { … }
  ]
}

Ticket Types

A list of ticket types associated with a given workspace.

typestring

String representing the object's type. Always has the value ticket_type.list.

ticket_typesArray of objects or null(Ticket Type)

A list of ticket_types associated with a given workspace.

{
  "type": "string",
  "ticket_types": [
    { … }
  ]
}