Common ModelsMessages

/messages/{id}

Returns a Message object with the given id.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Path parameters

idstringRequiredformat: "uuid"

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Response

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional

The third-party API ID of the matching object.

created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
user_idstring or nullOptionalformat: "uuid"
The user that sent the message.
conversation_idstring or nullOptionalformat: "uuid"
The conversation this message belongs to.
bodystring or nullOptional
The body of the message.
subject_linestring or nullOptional
The subject line of the message.
root_message_idstring or nullOptionalformat: "uuid"
The root message this message belongs to.
urlstring or nullOptionalformat: "uri"<=500 characters
The url of the message.
remote_created_atdatetime or nullOptional
When the third party's conversation was created.
remote_updated_atdatetime or nullOptional
When the third party's conversation was updated.
remote_was_deletedbooleanOptionalRead-only

Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.