DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Create a note

Example Request & Response

$ curl https://api.intercom.io/contacts/<id>/notes \
-X POST \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json' -d

{
  "body": "Shiny",
  "admin_id": "12345"
}
HTTP/1.1 200 OK
{
  "type": "note",
  "id": "12345",
  "created_at": 1569943728,
  "user": {
    "type": "user",
    "id": "5ba682d23d7cf92bef87bfd4"
  },
  "author": {
    "type": "admin",
    "id": "12345",
    "name": "Test",
    "email": "[email protected]",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "avatar": {
      "image_url": "https://test.test"
    }
  },
  "body": "<p>Shiny</p>"
}
Example Errors

HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "Contact Not Found"
    }
  ]
}
HTTP/1.1 404 NOT FOUND
{
  "type": "error.list",
  "request_id": "9a3d0816-9707-4598-977e-c009ba630148",
  "errors": [
    {
      "code": "not_found",
      "message": "Resource Not Found"
    }
  ]
}

You can remove a note to a single contact.

Request Path Parameter

Parameter

Type

Required?

Description

id

String

Yes

The unique identifier for the contact which is given by Intercom.

Request Body Parameter

Parameter

Type

Required?

Description

body

String

Yes

The text of the note.

admin_id

String

Yes

The unique identifier for the admin which is given by Intercom.

Response

This will return a Note model for the note that was added to the contact.