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

campaignsArray
Required
The campaigns receiving this marketing email.

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_atString
Optional
When the marketing email was created in the remote system.

remote_updated_atString
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_dateString
Optional
When the marketing email was sent.

templateString
Optional
The marketing email's template.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

idString
Required

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

created_atString
Required

modified_atString
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

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

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
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.

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
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

subjectString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

remote_created_atString

remote_idString

send_dateString

subjectString

templateString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

reply_toString

subjectString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

nameString

remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

statusEnum

subjectString

templateString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

from_nameString

remote_created_atString

remote_idString

remote_updated_atString

send_dateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

html_bodyString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

statusEnum

subjectString

templateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_updated_atString

reply_toString

send_dateString

statusEnum
Hint: 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

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

idString
Required

include_remote_dataBoolean
Optional
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
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

subjectString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

remote_created_atString

remote_idString

send_dateString

subjectString

templateString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

reply_toString

subjectString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

nameString

remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

statusEnum

subjectString

templateString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

from_nameString

remote_created_atString

remote_idString

remote_updated_atString

send_dateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

html_bodyString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

statusEnum

subjectString

templateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_updated_atString

reply_toString

send_dateString

statusEnum
Hint: 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

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

page_sizeInteger
Optional
Number of results to return per page.

parent_idString
Required

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
ActiveCampaign

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

subjectString
Customer.io
Customer.io

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

remote_created_atString

remote_idString

send_dateString

subjectString

templateString
getResponse
getResponse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Hubspot Marketing Hub
Hubspot Marketing Hub

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

remote_updated_atString

reply_toString

subjectString
Keap
Keap

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

subjectString
Klaviyo
Klaviyo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

nameString

remote_idString
Mailchimp
Mailchimp

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


bodyString

campaignsArray

from_emailString

from_nameString

html_bodyString

nameString

previewString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

reply_toString

send_dateString

statusEnum

subjectString

templateString
Podium
Podium

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


from_emailString

from_nameString

remote_created_atString

remote_idString

remote_updated_atString

send_dateString
SendGrid
SendGrid

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

html_bodyString

remote_dataRemoteData[]
pathstring
datastring

remote_idString

statusEnum

subjectString

templateString
Sendinblue
Sendinblue

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


campaignsArray

from_emailString

from_nameString

html_bodyString

remote_created_atString

remote_dataRemoteData[]
pathstring
datastring

remote_updated_atString

reply_toString

send_dateString

statusEnum
Hint: Use the /linked-accounts endpoint to pull platform support information.