Skip to content
Home/
REST API Reference
/
/
Create a note

Create a note

Request

You can add a note to a single contact.

Security
bearerAuth
Path
idintegerrequired

The unique identifier of a given contact.

Example:123
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"2.9"
Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.9
Bodyapplication/json
bodystringrequired

The text of the note.

Example:"New note"
contact_idstring

The unique identifier of a given contact.

Example:"123"
admin_idstring

The unique identifier of a given admin.

Example:"123"
curl -i -X POST \
  https://api.intercom.io/contacts/123/notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.9' \
  -d '{
    "contact_id": "6657aad76abd0164c24b0d0e",
    "admin_id": 991267354,
    "body": "Hello"
  }'

Responses

Successful response

Bodyapplication/json
typestring

String representing the object's type. Always has the value note.

Example:"note"
idstring

The id of the note.

Example:"17495962"
created_atinteger, (timestamp)

The time the note was created.

Example:1674589321
contactobject or null

Represents the contact that the note was created about.

authorobject or null(Admin)

Optional. Represents the Admin that created the note.

bodystring

The body text of the note.

Example:"<p>Text for the note.</p>"
Response
{
  "type": "note",
  "id": "34",
  "created_at": 1717021399,
  "contact": {
    "type": "contact",
    "id": "6657aad76abd0164c24b0d0e"
  },
  "author": {
    "type": "admin",
    "id": "991267354",
    "name": "Ciaran112 Lee",
    "email": "admin112@email.com",
    "away_mode_enabled": false,
    "away_mode_reassign": false
  },
  "body": "<p>Hello</p>"
}