Intercom API (unofficial showcase)
POST/contacts/{contact_id}/notes

Create a note for a contact

Creates a note for a contact. Supply the required body text and optionally specify the admin_id of the admin associated with the note. The response includes the created note and its contact and author details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
contact_idintegerrequired
The unique identifier of the contact to add the note to.
Intercom-Versionstringoptional
The Intercom API version to use; the listed values include 1.0 through 2.6. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Note details to associate with the contact.

bodystringrequired
The text of the note.
admin_idstringoptional
The unique identifier of a given admin.

2 status codes
200Returns the created note, including its identifier, creation time, contact, author, and body text.
typestringoptional
String representing the object's type. Always has the value `note`.
idstringoptional
The id of the note.
created_atintegeroptional
The time the note was created.
contactobjectoptional
Represents the contact that the note was created about.
companyobjectoptional
Represents the company that the note was created about.
authorobjectoptional
Admins are teammate accounts that have access to a workspace.
bodystringoptional
The body text of the note.
404Returned when the contact is not found.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 404 is returned when the contact identified by the contact_id path parameter is not found. The request body must include body; admin_id can be omitted. The Intercom-Version header defaults to 2.17 when omitted.