A Message represents a reply to an existing conversation or the message that originated a new conversation.
Conversations have one or more Messages, each of which is represented by a Message object.
A Message stores metadata about the message in question, including who sent it and when.
Messages must belong to a Conversation and can't exist outside of the context of a claim.
The Message Object
Message Object| Attribute | Data Type | Description |
|---|---|---|
| id | Integer | Read Only. The unique ID for the message given by Claimable. |
| subject | String | Read Only. The subject of the message. |
| preview | String | Read Only. A plain-text truncated preview of the message body. |
| body | String | Read Only. The message body. If the message originated from an inbound email this only shows the reply, not the full email thread. |
| outbound | Boolean | Read Only. Indicates if the message is outbound / sent from Claimable. |
| inbound | Boolean | Read Only. Indicates if the message is inbound to / received by Claimable. |
| sent_at | Timestamp | Read Only. When the message was sent to recipients. |
| attachments_count | Integer | Read Only. How many attachments are included in the message. |
| created_at | Timestamp | Read Only. When the message was created. |
| created_by | Integer | Read Only. The ID of the user who created the message. |
| conversation | Integer | Read Only. The ID of the conversation to which the message belongs. |
| sent_by | Integer | Read Only. The ID of the user who created and sent the message, if any. |
| sender | Object | Read Only. A ConversationParticipant object representing the party from whom the message is sent. This can be different to sent_by when sending via the API or when a user uses Ghostwriter Mode. |
| recipients | Object | Read Only. An array of ConversationParticipantobjects representing recipients of this message, excluding the sender. See the ConversationParticipant object definition for more. |
Example Message Object
Message Object{
"id": 12345,
"subject": "Your Claim #1234",
"preview": "Dear Mr. Smith, We confirm receipt of your claim...",
"body": "<p>Dear Mr. Smith,</p><p>We confirm receipt of your claim with reference #1234...</p>",
"outbound": true,
"inbound": false,
"sent_at": "2026-02-16T20:42:27.737Z",
"attachments_count": 1,
"created_at": "2026-02-16T20:42:27.707Z",
"created_by": 123,
"conversation": 112233,
"sent_by": 123,
"sender": {
"contact": null,
"company": null,
"user": 9, // <- The sender is a user.
"name": "James Bond",
"email": "[email protected]"
},
"recipients": [
{
"contact": 1234, // <- This participant has an associated contact record.
"company": null,
"user": null,
"name": "John Smith",
"email": "[email protected]" // <- Message was sent to this email address.
},
{
"contact": null,
"company": null,
"user": null,
"name": "[email protected]",
"email": "[email protected]" // <- Message was also sent to this email address.
}
]
}
