MarketingEmail
object is used to represent a marketing email in the remote system.campaigns
Arrayid
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)name
Stringsubject
Stringbody
Stringhtml_body
Stringfrom_name
Stringfrom_email
Stringpreview
Stringreply_to
Stringremote_created_at
DateTime (ISO 8601)remote_updated_at
DateTime (ISO 8601)status
EnumDRAFT
, QUEUED
, SENT
. In cases where there is no clear mapping, the original value passed through will be returned.send_date
DateTime (ISO 8601)template
UUIDremote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]https://api.merge.dev/api/mktg/v1/emails
Returns a list of MarketingEmail
objects.
created_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_id
String![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringsend_date
DateTime (ISO 8601)subject
Stringtemplate
UUID![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsubject
String![Keap](https://merge-api-production.s3.amazonaws.com/media/Platformkeap_square.png)
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
from_email
Stringname
Stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)status
Enumsubject
Stringtemplate
UUID![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)send_date
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
UUID![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsend_date
DateTime (ISO 8601)status
Enumhttps://api.merge.dev/api/mktg/v1/emails/{id}
Returns a MarketingEmail
object with the given id
.
id
UUIDinclude_remote_data
Boolean![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringsend_date
DateTime (ISO 8601)subject
Stringtemplate
UUID![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsubject
String![Keap](https://merge-api-production.s3.amazonaws.com/media/Platformkeap_square.png)
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
from_email
Stringname
Stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)status
Enumsubject
Stringtemplate
UUID![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)send_date
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
UUID![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsend_date
DateTime (ISO 8601)status
Enumhttps://api.merge.dev/api/mktg/v1/emails/{parent_id}/recipients
Returns a list of Contact
objects.
cursor
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanpage_size
Integerparent_id
UUID![ActiveCampaign](https://merge-api-production.s3.amazonaws.com/media/ActiveCampaign_square.jpg)
Supported Response Fields
body
Stringfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsubject
String![Customer.io](https://merge-api-production.s3.amazonaws.com/media/customer_io_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringsend_date
DateTime (ISO 8601)subject
Stringtemplate
UUID![getResponse](https://merge-api-production.s3.amazonaws.com/media/getresponse_square.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Hubspot Marketing Hub](https://merge-api-production.s3.amazonaws.com/media/PlatformHubspot.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsubject
String![Keap](https://merge-api-production.s3.amazonaws.com/media/Platformkeap_square.png)
Supported Response Fields
from_email
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)subject
String![Klaviyo](https://merge-api-production.s3.amazonaws.com/media/klaviyo_square.png)
Supported Response Fields
from_email
Stringname
Stringremote_id
String![Mailchimp](https://merge-api-production.s3.amazonaws.com/media/mailchimp_square_FoKtczJ.png)
Supported Response Fields
body
Stringcampaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringname
Stringpreview
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_id
Stringreply_to
Stringsend_date
DateTime (ISO 8601)status
Enumsubject
Stringtemplate
UUID![Podium](https://merge-api-production.s3.amazonaws.com/media/podium_square.png)
Supported Response Fields
from_email
Stringfrom_name
Stringremote_created_at
DateTime (ISO 8601)remote_id
Stringremote_updated_at
DateTime (ISO 8601)send_date
DateTime (ISO 8601)![SendGrid](https://merge-api-production.s3.amazonaws.com/media/sendgrid_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringhtml_body
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringstatus
Enumsubject
Stringtemplate
UUID![Sendinblue](https://merge-api-production.s3.amazonaws.com/media/sendinblue_square.png)
Supported Response Fields
campaigns
Arrayfrom_email
Stringfrom_name
Stringhtml_body
Stringremote_created_at
DateTime (ISO 8601)remote_data
RemoteData[]path
stringdata
stringremote_updated_at
DateTime (ISO 8601)reply_to
Stringsend_date
DateTime (ISO 8601)status
Enum