Home
/
REST API Reference
/
Models
/
Create Ticket Type Request Payload

Intercom API (Unstable)

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

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

Operations

Articles

Everything about your Articles

Operations

Internal Articles

Everything about your Internal Articles

Operations

Away Status Reasons

Everything about your away status reasons

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

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

Jobs

Everything about jobs

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 States

Everything about your ticket states

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

Create Ticket Type Attribute Request Payload

You can create a Ticket Type Attribute

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
{
  "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
}

Create Ticket Type Request Payload

The request payload for creating a ticket type. You can copy the icon property for your ticket type from Twemoji Cheatsheet

namestringrequired

The name of the ticket type.

Example: "Bug"
descriptionstring

The description of the ticket type.

Example: "Used for tracking bugs"
categorystring

Category of the Ticket Type.

Enum"Customer""Back-office""Tracker"
Example: "Customer"
iconstring

The icon of the ticket type.

Default "🎟️"
Example: "🐞"
is_internalboolean

Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.

Default false
Example: false
{
  "name": "Bug",
  "description": "Used for tracking bugs",
  "category": "Customer",
  "icon": "🐞",
  "is_internal": false
}

Cursor based pages

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

typestring

the type of object pages.

Value"pages"
Example: "pages"
pageinteger

The current page

Example: 1
nextobject or null(Pagination: Starting After)
per_pageinteger

Number of results per page

Example: 2
total_pagesinteger

Total number of pages

Example: 13
{
  "type": "pages",
  "page": 1,
  "next": {
    "per_page": 2,
    "starting_after": "your-cursor-from-response"
  },
  "per_page": 2,
  "total_pages": 13
}