Messages
The
Message object is used to represent a message within the Chat account.Properties
idUUIDremote_idStringThe third-party API ID of the matching object.
created_atDateTime (ISO 8601)The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)The datetime that this object was modified by Merge.
user_idUUIDThe user that sent the message.
conversation_idUUIDThe conversation this message belongs to.
bodyStringThe body of the message.
subject_lineStringThe subject line of the message.
root_message_idUUIDThe root message this message belongs to.
urlStringThe url of the message.
remote_created_atDateTime (ISO 8601)When the third party's conversation was created.
remote_updated_atDateTime (ISO 8601)When the third party's conversation was updated.
remote_was_deletedBooleanIndicates 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.
GET
/messages
https://api.merge.dev/api/chat/v1/messages
US
EU
APAC
Returns a list of Message objects.
Query & path parameters
conversation_idUUIDOptional
Filter messages by conversation ID.
created_afterDateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_beforeDateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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.
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).
modified_afterDateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeDateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
order_byStringOptional
Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
root_messageStringOptional
If provided as 'true', will only return root messages (messages without a parent message).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Teams
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringconversation_idUUIDremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)root_message_idUUIDsubject_lineStringurlStringuser_idUUIDNot seeing an integration that you're looking for?
GET
/messages/{id}
https://api.merge.dev/api/chat/v1/messages/{id}
US
EU
APAC
Returns a Message object with the given id.
Query & path parameters
idUUIDRequired
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).
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Teams
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringconversation_idUUIDremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)root_message_idUUIDsubject_lineStringurlStringuser_idUUIDNot seeing an integration that you're looking for?
GET
/messages/{message_id}/replies
https://api.merge.dev/api/chat/v1/messages/{message_id}/replies
US
EU
APAC
Returns a list of Message objects.
Query & path parameters
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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.
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).
message_idUUIDRequired
order_byStringOptional
Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.
page_sizeIntegerOptional
Number of results to return per page. The maximum limit is 100.
Field support by integration
Use the /linked-accounts endpoint to pull platform support information
Microsoft Teams
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringconversation_idUUIDremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)root_message_idUUIDsubject_lineStringurlStringuser_idUUIDNot seeing an integration that you're looking for?