Example Note Object
{
"type": "note",
"id": "16",
"created_at": 1389913941,
"body": "<p>Text for my note</p>",
"author": {
"type": "admin",
"id": "21",
"name": "Jayne Cobb",
"email": "[email protected]",
"companies": []
},
"user": {
"type": "user",
"id": "5310d8e8598c9a0b24000005"
}
}
Notes allow you to annotate and comment on your contacts.
Companies and Conversations
Currently not possible to create notes for companies. Reach out if you want to submit a feature request, we take these into account.
Conversations notes are created via the Reply a conversations API.
Object Models
Note
| Field | Type | Description |
|---|---|---|
| type | string | String representing the object's type. Always has the value note. |
| id | string | The id of the note. |
| created_at | integer | The time the note was created. |
| contact | object | Represents the contact that the note was created about. |
| author | object | Admins are teammate accounts that have access to a workspace. |
| body | string | The body text of the note. |
Admin
| Field | Type | Description |
|---|---|---|
| type | string | String representing the object's type. Always has the value admin. |
| id | string | The id representing the admin. |
| name | string | The name of the admin. |
| string | The email of the admin. | |
| job_title | string | The job title of the admin. |
| away_mode_enabled | boolean | Identifies if this admin is currently set in away mode. |
| away_mode_reassign | boolean | Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. |
| has_inbox_seat | boolean | Identifies if this admin has a paid inbox seat to restrict/allow features that require them. |
| team_ids | array | This object represents the avatar associated with the admin. |
| avatar | string | Image for the associated team or teammate |
| team_priority_level | object | Admin priority levels for teams |