Home
/
REST API Reference
/
Models
/
A Ticket Part representing a note

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 Attributes

An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are _default_title_ and _default_description_.

property name*(string or null) or number or boolean or Array of arrays or File (object)additional property
Any of:
string or null
{
  "_default_title_": "Found a bug",
  "_default_description_": "The button's not working"
}

A Ticket Part representing a note

A Ticket Part representing a note in the ticket

typestring

Always ticket_part

Value"ticket_part"
Example: "ticket_part"
idstring

The id representing the note.

Example: "3"
part_typestring

Always note

Value"note"
Example: "note"
bodystring or null

The message body, which may contain HTML.

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

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 part author

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

typestring
Enum"admin""bot""team"
idstring

The id of the author

Example: "274"
namestring or null

The name of the author

Example: "Operator"
emailstring(email)

The email of the author

Example: "operator+abcd1234@intercom.io"
{
  "type": "admin",
  "id": "274",
  "name": "Operator",
  "email": "operator+abcd1234@intercom.io"
}