Create a note

You can add a note to a single contact.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
integer

The unique identifier of a given contact.

Example: 123
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

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

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
Request Body schema: application/json
body
required
string

The text of the note.

contact_id
string

The unique identifier of a given contact.

admin_id
string

The unique identifier of a given admin.

post
/contacts/{id}/notes
Request samples
application/json
{ "contact_id": "664df5626abd01f7945e1af0", "admin_id": 991270095, "body": "Hello" }
Responses

200

Successful response

Response Schema: application/json
type
string

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

id
string

The id of the note.

created_at
integer <timestamp>

The time the note was created.

object or null

Represents the contact that the note was created about.

object or null (Admin)

Admins are teammate accounts that have access to a workspace.

body
string

The body text of the note.

404

Contact not found

Response samples
application/json
{ "type": "note", "id": "99", "created_at": 1716385123, "contact": { "type": "contact", "id": "664df5626abd01f7945e1af0" }, "author": { "type": "admin", "id": "991270095", "name": "Ciaran103 Lee", "email": "admin103@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>Hello</p>" }