Skip to content
Home
/
REST API Reference
/
Models
/
A Ticket Part representing a note, comment, or quick_reply on a ticket

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

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Ticket Parts

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

typestringrequired
Value"ticket_part.list"
Example: "ticket_part.list"
ticket_partsArray of objects(Tickt Parts)required

A list of Ticket Part objects for each ticket. There is a limit of 500 parts.

ticket_parts[].​typestringrequired

Always ticket_part

Value"ticket_part"
Example: "ticket_part"
ticket_parts[].​idstringrequired

The id representing the ticket part.

Example: "3"
ticket_parts[].​part_typestringrequired

The type of ticket part.

Example: "comment"
ticket_parts[].​bodystring or nullrequired

The message body, which may contain HTML.

Example: "<p>Okay!</p>"
ticket_parts[].​previous_ticket_statestring

The previous state of the ticket.

Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
ticket_parts[].​ticket_statestringrequired

The state of the ticket.

Enum"submitted""in_progress""waiting_on_customer""resolved"
Example: "submitted"
ticket_parts[].​created_atinteger(date-time)required

The time the ticket part was created.

Example: 1663597223
ticket_parts[].​updated_atinteger(date-time)

The last time the ticket part was updated.

Example: 1663597260
ticket_parts[].​assigned_toobject(Reference)

reference to another object

ticket_parts[].​authorobject(Ticket part author)

The author that wrote or triggered the part. Can be a bot, admin, team or user.

ticket_parts[].​attachmentsArray of objects(Ticket part attachments)

A list of attachments for the part.

ticket_parts[].​external_idstring or null

The external id of the ticket part

Example: "abcd1234"
ticket_parts[].​redactedboolean

Whether or not the ticket part has been redacted.

Example: false
total_countintegerrequired
Example: 2
{
  "type": "ticket_part.list",
  "ticket_parts": [
    { … }
  ],
  "total_count": 2
}

A Ticket Part representing a note, comment, or quick_reply on a ticket

A Ticket Part representing a note, comment, or quick_reply on a ticket

typestringrequired

Always ticket_part

Value"ticket_part"
Example: "ticket_part"
idstringrequired

The id representing the part.

Example: "3"
part_typestringrequired

Type of the part

Enum"note""comment""quick_reply"
Example: "note"
bodystring or null

The message body, which may contain HTML.

Example: "<p>Okay!</p>"
created_atinteger(date-time)required

The time the note was created.

Example: 1663597223
updated_atinteger(date-time)

The last time the note was updated.

Example: 1663597260
authorobject(Ticket part author)

The author that wrote or triggered the part. Can be a bot, admin, team or user.

attachmentsArray of objects(Ticket part attachments)

A list of attachments for the part.

redactedboolean

Whether or not the ticket part has been redacted.

Example: false
{
  "type": "ticket_part",
  "id": "3",
  "part_type": "note",
  "body": "<p>Okay!</p>",
  "created_at": 1663597223,
  "updated_at": 1663597260,
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Operator",
    "email": "operator+abcd1234@intercom.io"
  },
  "attachments": [
    { … }
  ],
  "redacted": false
}

Ticket Attributes

The attributes set on the ticket. When setting the default title and description attributes, the attribute keys that should be used are _default_title_ and _default_description_. When setting ticket type attributes of the list attribute type, the key should be the attribute name and the value of the attribute should be the list item id, obtainable by listing the ticket type. For example, if the ticket type has an attribute called priority of type list, the key should be priority and the value of the attribute should be the guid of the list item (e.g. de1825a0-0164-4070-8ca6-13e22462fa7e).

property name*(string or null) or number or boolean or Array of arraysadditional property
Any of:
string or null
{
  "_default_title_": "Found a bug",
  "_default_description_": "The button is not working"
}