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
idUUID
Required
remote_idString
Optional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.
from_nameString
Optional
The message's from-name.
send_dateDateTime (ISO 8601)
Optional
When the message was sent.
bodyString
Optional
The message's body.
remote_was_deletedBoolean
Required
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.
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
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.
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
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_sizeInteger
Optional
Number of results to return per page.
remote_idString
Optional
The API provider's ID for the given object.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Klaviyo
Klaviyo
MessageBird
MessageBird
Sendinblue
Sendinblue
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
idUUID
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Klaviyo
Klaviyo
MessageBird
MessageBird
Sendinblue
Sendinblue
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
cursorString
Optional
The pagination cursor value.
include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
page_sizeInteger
Optional
Number of results to return per page.
parent_idUUID
Required
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Customer.io
Customer.io
Klaviyo
Klaviyo
MessageBird
MessageBird
Sendinblue
Sendinblue
Previous
Lists
Next Up
Templates