DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

The note model

Example Note Object

{
  "type": "note",
  "id": "16",
  "created_at": 1389913941,
  "body": "<p>Text for my note</p>",
  "author": {
    "type": "admin",
    "id": "21",
    "name": "Jayne Cobb",
    "email": "[email protected]",
    "companies": []
  },
  "user": {
    "type": "user",
    "id": "5310d8e8598c9a0b24000005"
  }
}

Notes allow you to annotate and comment on your contacts.

📘

Companies and Conversations

Currently not possible to create notes for companies. Reach out if you want to submit a feature request, we take these into account.

Conversations notes are created via the Reply a conversations API.

Note Object

Key

Type

Description

type

String

value is 'note'

id

String

The id representing the note

created_at

Timestamp

The time the note was created

user

Object

The user the note was created about

body

String

The body text of the note.

author

Object

Optional. Represents the Admin that created the note