Messages
The
Message object is used to represent a text message, in-app message or a message sent via another channel in the remote system.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.
from_nameStringThe message's from-name.
send_dateDateTime (ISO 8601)When the message was sent.
bodyStringThe message's body.
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.
field_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
GET
/messages
https://api.merge.dev/api/mktg/v1/messages
US
EU
APAC
Returns a list of Message objects.
Query & path parameters
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.
page_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringremote_idStringsend_dateDateTime (ISO 8601)
MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)GET
/messages/{id}
https://api.merge.dev/api/mktg/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.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringremote_idStringsend_dateDateTime (ISO 8601)MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)GET
/messages/{parent_id}/recipients
https://api.merge.dev/api/mktg/v1/messages/{parent_id}/recipients
US
EU
APAC
Returns a list of Contact 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).
page_sizeIntegerOptional
Number of results to return per page.
parent_idUUIDRequired
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
Customer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringremote_idStringsend_dateDateTime (ISO 8601)MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_nameStringremote_dataRemoteData[]pathstringdatastringremote_idStringsend_dateDateTime (ISO 8601)