GET
/emails

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",
Show advanced fields
    }
  ]
}
GET
/emails/{id}

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",
Show advanced fields
}
GET
/emails/{parent_id}/recipients

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": "USA",
      "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",
Show advanced fields
    }
  ]
}
Previous
Contacts
Next Up
Events