POST api/Campaigns/GetEmails?includeMergeFields={includeMergeFields}

Provides a list of emails that can be used as part of the SendEmails API. This API has an option that allows you choose if you want to get the merge fields. For example, if you only need the email names and ids, you can choose not to get the merge fields and return results faster.

Request Information

URI Parameters

Name	Description	Type	Additional information
includeMergeFields	Allows you determine if you only want to receive the list of reusable emails or if you want to include Merge fields that have been defined for those emails.	boolean	Default value is True

Body Parameters

None.

Response Information

Resource Description

GetEmailsResponseModel

Name	Description	Type	Additional information
EmailCampaigns	List of associated email campaigns	Collection of EmailCampaign	None.
ProcessType	This will be used by the Marketing Data Platform/ExecuTrax integration process. It shows how your Digital Communication accounts are setup and the following ProcessType options are possible in the results: 1 = Marquis Managed – this means that Marquis is creating your emails and coordinating the integration between Marketing Data Platform/ExecuTrax and Digital Communication, 2 = Client Managed – this means that you are creating your emails and using the Marketing Data Platform/ExecuTrax integration process and/or files through Digital Communication On Demand (DOD), NULL = Your account hasn’t been defined to use the Marketing Data Platform/ExecuTrax integration process	integer	None.
InstitutionID	This relates to the Marketing Data Platform/ExecuTrax integration process and is the unique identifier Marquis uses for that integration	string	None.
IsSuccessful	Indicator of whether the request was successful	boolean	None.
ErrorMessage	This will contain details of the error if it was not successful	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 3",
  "EmailCampaigns": [
    {
      "EmailID": "sample string 1",
      "EmailName": "sample string 2",
      "CampaignID": "sample string 3",
      "HasAntiPhishing": true,
      "UsedMergeFields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "VersionCode": "sample string 5",
      "FullVersionCode": "sample string 6"
    },
    {
      "EmailID": "sample string 1",
      "EmailName": "sample string 2",
      "CampaignID": "sample string 3",
      "HasAntiPhishing": true,
      "UsedMergeFields": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ReplaceName": "sample string 3"
        }
      ],
      "VersionCode": "sample string 5",
      "FullVersionCode": "sample string 6"
    }
  ],
  "ProcessType": 1,
  "InstitutionID": "sample string 1"
}

application/xml, text/xml

Sample:

<GetEmailsResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 3</ErrorMessage>
  <EmailCampaigns>
    <EmailCampaign>
      <EmailID>sample string 1</EmailID>
      <EmailName>sample string 2</EmailName>
      <CampaignID>sample string 3</CampaignID>
      <HasAntiPhishing>true</HasAntiPhishing>
      <UsedMergeFields>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </UsedMergeFields>
      <VersionCode>sample string 5</VersionCode>
      <FullVersionCode>sample string 6</FullVersionCode>
    </EmailCampaign>
    <EmailCampaign>
      <EmailID>sample string 1</EmailID>
      <EmailName>sample string 2</EmailName>
      <CampaignID>sample string 3</CampaignID>
      <HasAntiPhishing>true</HasAntiPhishing>
      <UsedMergeFields>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
        <MergeField>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
          <ReplaceName>sample string 3</ReplaceName>
        </MergeField>
      </UsedMergeFields>
      <VersionCode>sample string 5</VersionCode>
      <FullVersionCode>sample string 6</FullVersionCode>
    </EmailCampaign>
  </EmailCampaigns>
  <ProcessType>1</ProcessType>
  <InstitutionID>sample string 1</InstitutionID>
</GetEmailsResponseModel>