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
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
created_at
DateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_at
DateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
from_name
StringOptional
The message's from-name.
send_date
DateTime (ISO 8601)Optional
When the message was sent.
body
StringOptional
The message's body.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/messages
https://api.merge.dev/api/mktg/v1/messages
US
EU
APAC
Returns a list of Message
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
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](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
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
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringremote_id
Stringsend_date
DateTime (ISO 8601)![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (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
id
UUIDRequired
include_remote_data
BooleanOptional
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](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
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
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringremote_id
Stringsend_date
DateTime (ISO 8601)![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (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
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_size
IntegerOptional
Number of results to return per page.
parent_id
UUIDRequired
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
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
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringremote_id
Stringsend_date
DateTime (ISO 8601)![MessageBird](https://merge-api-production.s3.amazonaws.com/media/messagebird_square_y8wjgQQ.png)
MessageBird
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
body
Stringfrom_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringsend_date
DateTime (ISO 8601)