GET
/emails
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, will only return objects modified after this datetime.
modified_beforeStringOptional
If provided, will only return objects modified before this datetime.
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","id": "2634cbc6-6040-430a-475r-aafacbadf9he","remote_id": "15"}]}
GET
/emails/{id}
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","id": "2634cbc6-6040-430a-475r-aafacbadf9he","remote_id": "15"}
GET
/emails/{parent_id}/recipients
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": "USA","postal_code": "string","remote_created_at": "2022-12-23T00:00:00Z","remote_updated_at": "2022-12-23T00:00:00Z","id": "5858cbc6-6040-430a-475r-aafacbadrg64","remote_id": "35"}]}