Notes are descriptive text-based records belonging to claims, contacts or companies.
Note objects provide a way to record a text-based narrative about a parent object. They must belong to a parent object, which can be either a Claim, Contact or Company.
The Note Object
Note Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | The unique ID for the note given by Claimable. |
| body | String | The text that forms the body of the note. Supports HTML tags:<a>, <strong>, <em>, <u>, <p>, <ul>, <ol>, <li>, <br> |
| pinned | Boolean | Indicates if the note is pinned (true) or not (false). |
| pinned_by | Integer | Read Only The id of the user who pinned the note, if pinned: true. |
| pinned_at | Timestamp | Read Only The date/time the note was pinned, if pinned: true. |
| created_at | Timestamp | Read Only The date/time the note was created. |
| updated_at | Timestamp | Read Only The date/time the note was last updated. |
| created_by | Integer | Read Only The id of the user who created the note. |
| updated_by | Integer | Read Only The id of the user who last updated the note. |
Example Note Object
{
"id": 123456,
"body": "I called the customer and they are happy to proceed with the settlement offer.",
"pinned": true,
"pinned_by": 123,
"pinned_at": "2020-12-01T09:22:19.394Z",
"created_at": "2020-12-01T09:22:19.394Z",
"updated_at": "2020-12-06T16:42:32.541Z",
"created_by": 123,
"updated_by": 456
}