Skip to content
Home/
REST API Reference
/
/
Note

Note

Notes allow you to annotate and comment on your contacts.

typestringrequired

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

Value:"note"
Example:"note"
idstringrequired

The id of the note.

Example:"17495962"
created_atinteger, (timestamp)required

The time the note was created.

Example:1674589321
contactobject or nullrequired

Represents the contact that the note was created about.

authorobject(Admin)required

Optional. Represents the Admin that created the note.

bodystringrequired

The body text of the note.

Example:"<p>Text for the note.</p>"
{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "contact": {
    "type": "contact",
    "id": "214656d0c743eafcfde7f248"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Hoban Washburne",
    "email": "wash@serenity.io",
    "job_title": "Philosopher",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "has_inbox_seat": true,
    "team_ids": [ … ],
    "avatar": "https://picsum.photos/200/300",
    "team_priority_level": { … }
  },
  "body": "<p>Text for the note.</p>"
}