Emails
The MarketingEmail object is used to represent a marketing email in the remote system.
Properties

campaignsArray
Required
The campaigns receiving this marketing email.

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required
The datetime that this object was created by Merge.

modified_atDateTime (ISO 8601)
Required
The datetime that this object was modified by Merge.

nameString
Optional
The marketing email's name.

subjectString
Optional
The marketing email's subject.

bodyString
Optional
The marketing email's body.

html_bodyString
Optional
The marketing email's html body.

from_nameString
Optional
The marketing email's from name.

from_emailString
Optional
The marketing email's from email.

previewString
Optional
The marketing email's preview.

reply_toString
Optional
The marketing email's reply-to.

remote_created_atDateTime (ISO 8601)
Optional
When the marketing email was created in the remote system.

remote_updated_atDateTime (ISO 8601)
Optional
When the marketing email was last updated in the remote system.

statusEnum
Optional
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_dateDateTime (ISO 8601)
Optional
When the marketing email was sent.

templateUUID
Optional
The marketing email's template.

remote_was_deletedBoolean
Required
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.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


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.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean
Optional
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_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Keap
Keap
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/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

idUUID
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Keap
Keap
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue
GET
/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

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
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_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

page_sizeInteger
Optional
Number of results to return per page.

parent_idUUID
Required

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ActiveCampaign
ActiveCampaign
Customer.io
Customer.io
getResponse
getResponse
Hubspot Marketing Hub
Hubspot Marketing Hub
Keap
Keap
Klaviyo
Klaviyo
Mailchimp
Mailchimp
Podium
Podium
SendGrid
SendGrid
Sendinblue
Sendinblue