Emails
The
MarketingEmail object is used to represent a marketing email in the remote system.Properties
campaignsArrayThe campaigns receiving this marketing email.
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.
nameStringThe marketing email's name.
subjectStringThe marketing email's subject.
bodyStringThe marketing email's body.
html_bodyStringThe marketing email's html body.
from_nameStringThe marketing email's from name.
from_emailStringThe marketing email's from email.
previewStringThe marketing email's preview.
reply_toStringThe marketing email's reply-to.
remote_created_atDateTime (ISO 8601)When the marketing email was created in the remote system.
remote_updated_atDateTime (ISO 8601)When the marketing email was last updated in the remote system.
statusEnumThe marketing email's status. Possible values include:
DRAFT, QUEUED, SENT. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.send_dateDateTime (ISO 8601)When the marketing email was sent.
templateUUIDThe marketing email's template.
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
/emails
https://api.merge.dev/api/mktg/v1/emails
US
EU
APAC
Returns a list of MarketingEmail 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
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectString
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
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atDateTime (ISO 8601)remote_idStringsend_dateDateTime (ISO 8601)subjectStringtemplateUUID
getResponse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectString
Hubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)reply_toStringsubjectString
Keap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectString
Klaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringnameStringremote_idString
Mailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)statusEnumsubjectStringtemplateUUID
Podium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)send_dateDateTime (ISO 8601)
SendGrid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateUUID
Sendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_updated_atDateTime (ISO 8601)reply_toStringsend_dateDateTime (ISO 8601)statusEnumGET
/emails/{id}
https://api.merge.dev/api/mktg/v1/emails/{id}
US
EU
APAC
Returns a MarketingEmail 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
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectStringCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atDateTime (ISO 8601)remote_idStringsend_dateDateTime (ISO 8601)subjectStringtemplateUUIDgetResponse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectStringHubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)reply_toStringsubjectStringKeap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectStringKlaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringnameStringremote_idStringMailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)statusEnumsubjectStringtemplateUUIDPodium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)send_dateDateTime (ISO 8601)SendGrid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateUUIDSendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_updated_atDateTime (ISO 8601)reply_toStringsend_dateDateTime (ISO 8601)statusEnumGET
/emails/{parent_id}/recipients
https://api.merge.dev/api/mktg/v1/emails/{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
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectStringCustomer.io
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atDateTime (ISO 8601)remote_idStringsend_dateDateTime (ISO 8601)subjectStringtemplateUUIDgetResponse
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectStringHubspot Marketing Hub
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atDateTime (ISO 8601)reply_toStringsubjectStringKeap
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)subjectStringKlaviyo
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringnameStringremote_idStringMailchimp
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateDateTime (ISO 8601)statusEnumsubjectStringtemplateUUIDPodium
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atDateTime (ISO 8601)remote_idStringremote_updated_atDateTime (ISO 8601)send_dateDateTime (ISO 8601)SendGrid
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateUUIDSendinblue
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atDateTime (ISO 8601)remote_dataRemoteData[]pathstringdatastringremote_updated_atDateTime (ISO 8601)reply_toStringsend_dateDateTime (ISO 8601)statusEnum