Emails
The MarketingEmail object is used to represent a marketing email in the remote system.Properties
campaignsArrayRequired
The campaigns receiving this marketing email.
nameStringOptional
The marketing email's name.
subjectStringOptional
The marketing email's subject.
bodyStringOptional
The marketing email's body.
html_bodyStringOptional
The marketing email's html body.
from_nameStringOptional
The marketing email's from name.
from_emailStringOptional
The marketing email's from email.
previewStringOptional
The marketing email's preview.
reply_toStringOptional
The marketing email's reply-to.
remote_created_atStringOptional
When the marketing email was created in the remote system.
remote_updated_atStringOptional
When the marketing email was last updated in the remote system.
statusEnumOptional
The 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.send_dateStringOptional
When the marketing email was sent.
templateStringOptional
The marketing email's template.
remote_was_deletedBooleanRequired
Indicates whether or not this object has been deleted by third party webhooks.
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atStringRequired
modified_atStringRequired
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
remote_dataRemoteData[]Optional
The Email object
JSON
{"name": "Welcome Email","subject": "Welcome onboard!","body": "Welcome onboard! Stay connected and find out more.","html_body": "<b>Welcome onboard</b>! Stay connected and find out more.","from_name": "Merge","from_email": "[email protected]","preview": "Welcome onboard!","reply_to": "[email protected]","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","status": "SENT","send_date": "2022-12-25T00:00:00Z","template": "4958cbc6-4874-430a-475r-aafacbadd5ty","campaigns": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_was_deleted": true,"id": "2634cbc6-6040-430a-475r-aafacbadf9he","remote_id": "15","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}
GET
/emails
https://api.merge.dev/api/mktg/v1/emails
US
EU
Returns a list of MarketingEmail objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
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.
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"name": "Welcome Email","subject": "Welcome onboard!","body": "Welcome onboard! Stay connected and find out more.","html_body": "<b>Welcome onboard</b>! Stay connected and find out more.","from_name": "Merge","from_email": "[email protected]","preview": "Welcome onboard!","reply_to": "[email protected]","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","status": "SENT","send_date": "2022-12-25T00:00:00Z","template": "4958cbc6-4874-430a-475r-aafacbadd5ty","campaigns": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_was_deleted": true,"id": "2634cbc6-6040-430a-475r-aafacbadf9he","remote_id": "15","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}]}
Field support by platform
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectString
Customer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atStringremote_idStringsend_dateStringsubjectStringtemplateString
getResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectString
Hubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atStringreply_toStringsubjectString
Keap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectString
Klaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringnameStringremote_idString
Mailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringstatusEnumsubjectStringtemplateString
Podium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atStringremote_idStringremote_updated_atStringsend_dateString
SendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateString
Sendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_updated_atStringreply_toStringsend_dateStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/emails/{id}
https://api.merge.dev/api/mktg/v1/emails/{id}
US
EU
Returns a MarketingEmail object with the given id.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
idStringRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
Response
JSON
{"name": "Welcome Email","subject": "Welcome onboard!","body": "Welcome onboard! Stay connected and find out more.","html_body": "<b>Welcome onboard</b>! Stay connected and find out more.","from_name": "Merge","from_email": "[email protected]","preview": "Welcome onboard!","reply_to": "[email protected]","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","status": "SENT","send_date": "2022-12-25T00:00:00Z","template": "4958cbc6-4874-430a-475r-aafacbadd5ty","campaigns": "3737cbc6-6040-430a-475r-aafacbadrf47","remote_was_deleted": true,"id": "2634cbc6-6040-430a-475r-aafacbadf9he","remote_id": "15","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}
Field support by platform
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectStringCustomer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atStringremote_idStringsend_dateStringsubjectStringtemplateStringgetResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectStringHubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atStringreply_toStringsubjectStringKeap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectStringKlaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringnameStringremote_idStringMailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringstatusEnumsubjectStringtemplateStringPodium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atStringremote_idStringremote_updated_atStringsend_dateStringSendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateStringSendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_updated_atStringreply_toStringsend_dateStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.
GET
/emails/{parent_id}/recipients
https://api.merge.dev/api/mktg/v1/emails/{parent_id}/recipients
US
EU
Returns a list of Contact objects.
Header Parameters
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
page_sizeIntegerOptional
Number of results to return per page.
parent_idStringRequired
Response
JSON
{"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw","previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ","results": [{"first_name": "Gil","last_name": "Feig","email": "[email protected]","phone": "+13785579223","state": "NY","country": "US","postal_code": "string","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","remote_was_deleted": true,"id": "5858cbc6-6040-430a-475r-aafacbadrg64","remote_id": "35","created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}]}
Field support by platform
ActiveCampaign
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsubjectStringCustomer.io
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringremote_created_atStringremote_idStringsend_dateStringsubjectStringtemplateStringgetResponse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectStringHubspot Marketing Hub
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringremote_updated_atStringreply_toStringsubjectStringKeap
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringsubjectStringKlaviyo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringnameStringremote_idStringMailchimp
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
bodyStringcampaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringnameStringpreviewStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_idStringreply_toStringsend_dateStringstatusEnumsubjectStringtemplateStringPodium
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_emailStringfrom_nameStringremote_created_atStringremote_idStringremote_updated_atStringsend_dateStringSendGrid
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringhtml_bodyStringremote_dataRemoteData[]pathstringdatastringremote_idStringstatusEnumsubjectStringtemplateStringSendinblue
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaignsArrayfrom_emailStringfrom_nameStringhtml_bodyStringremote_created_atStringremote_dataRemoteData[]pathstringdatastringremote_updated_atStringreply_toStringsend_dateStringstatusEnumHint: Use the /linked-accounts endpoint to pull platform support information.