MarketingEmail
object is used to represent a marketing email in the remote system.campaigns
Arrayname
Stringsubject
Stringbody
Stringhtml_body
Stringfrom_name
Stringfrom_email
Stringpreview
Stringreply_to
Stringremote_created_at
Stringremote_updated_at
Stringstatus
EnumDRAFT
, QUEUED
, SENT
. In cases where there is no clear mapping, the original value passed through will be returned.send_date
Stringtemplate
Stringremote_was_deleted
Booleanid
Stringremote_id
Stringcreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
RemoteData[]{"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}
https://api.merge.dev/api/mktg/v1/emails
Returns a list of MarketingEmail
objects.
Authorization
StringX-Account-Token
Stringcreated_after
Stringcreated_before
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_id
String{"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}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
Stringremote_id
Stringsend_date
Stringsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringname
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsend_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_updated_at
Stringreply_to
Stringsend_date
Stringstatus
Enumhttps://api.merge.dev/api/mktg/v1/emails/{id}
Returns a MarketingEmail
object with the given id
.
Authorization
StringX-Account-Token
Stringid
Stringinclude_remote_data
Boolean{"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}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
Stringremote_id
Stringsend_date
Stringsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringname
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsend_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_updated_at
Stringreply_to
Stringsend_date
Stringstatus
Enumhttps://api.merge.dev/api/mktg/v1/emails/{parent_id}/recipients
Returns a list of Contact
objects.
Authorization
StringX-Account-Token
Stringcursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanpage_size
Integerparent_id
String{"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}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
Stringremote_id
Stringsend_date
Stringsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
Stringreply_to
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringsubject
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringname
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
Stringremote_id
Stringremote_updated_at
Stringsend_date
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
Stringremote_data
RemoteData[]path
stringdata
stringremote_updated_at
Stringreply_to
Stringsend_date
Stringstatus
Enum