POST v1/Emails/Send

Send an email document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DistributionListID	globally unique identifier	None.
DistributionListName	string	None.
DataSourceCategoryID	integer	None.
EntityID	integer	None.
EntityType	string	None.
DocumentID	integer	None.
DocumentName	string	None.
Description	string	None.
EditMode	boolean	None.
CopyMode	boolean	None.
EmailTo	string	None.
EmailFrom	string	None.
UseSystemEmailFrom	boolean	None.
EmailSubject	string	None.
EmailBcc	string	None.
Emailcc	string	None.
EmailBody	string	None.
EmailHeaderValidated	boolean	None.
DistributionListRecipients	Collection of BulkLetterDistributionRecipients	None.
EmailSource	string	None.
TemplateDataSource	string	None.
ReportCategory	DtoReportCategory	None.
CancelUrl	string	None.
LogoUrl	string	None.
SelectedSignatureId	string	None.
SignatureUrl	string	None.
OrderBy	string	None.
SortDirection	string	None.
StandardDistributionList	StandardDistributionListDTO	None.
CustomDistributionListData	CustomDistributionList	None.
TemplateWasSelected	boolean	None.
SelectedTemplate	string	None.
SelectedLocation	integer	None.
TemplateID	globally unique identifier	None.
Template	string	None.
TemplateHasPolicyRelatedFields	boolean	None.
CanUnsubscribe	boolean	None.
Title	string	None.
Notes	string	None.
DeliveryOpt	string	None.
ShowEmailAttachTab	boolean	None.
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedOn	date	None.
BlobFileID	integer	None.
IsEmail	boolean	None.
ContactID	integer	None.
PolicyID	integer	None.
ResendEmail	boolean	None.
UseSendGridApi	boolean	None.
EmailEventId	globally unique identifier	None.
CampaignGuid	globally unique identifier	None.
EnableOpenTracking	boolean	None.
EnableClickTracking	boolean	None.
EnableSpamCheck	boolean	None.
InsertEventTracker	boolean	None.
TemplateDocumentDataSource	QQDocumentDataSource	None.
TemplateDocumentMetadata	QQDocumentMetadata	None.
EmailAttachments	Collection of integer	None.
EmailAttachmentsFileNames	Collection of string	None.
EmailAcords	Collection of DocumentSessionAcordData	None.
contextInfo	ContextInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailAttachments": [
    1,
    2
  ],
  "EmailAttachmentsFileNames": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailAcords": [
    {
      "ID": 1,
      "CertHolders": [
        1,
        2
      ],
      "FromAcordEditor": true,
      "AcordNameAsSent": "sample string 3"
    },
    {
      "ID": 1,
      "CertHolders": [
        1,
        2
      ],
      "FromAcordEditor": true,
      "AcordNameAsSent": "sample string 3"
    }
  ],
  "contextInfo": {
    "Elements": {
      "sample string 1": 2,
      "sample string 3": 4
    },
    "GuidElements": {
      "sample string 1": "e7011911-46b7-4f2c-93c1-88970140e2da",
      "sample string 3": "aa7ebbc3-8cea-4e6c-a8ff-2c71bb99996a"
    }
  },
  "DistributionListID": "904a5872-42a0-42d8-8a3a-d1845298bf23",
  "DistributionListName": "sample string 2",
  "DataSourceCategoryID": 1,
  "EntityID": 3,
  "EntityType": "sample string 4",
  "DocumentID": 5,
  "DocumentName": "sample string 6",
  "Description": "sample string 7",
  "EditMode": true,
  "CopyMode": true,
  "EmailTo": "sample string 10",
  "EmailFrom": "sample string 11",
  "UseSystemEmailFrom": true,
  "EmailSubject": "sample string 13",
  "EmailBcc": "sample string 14",
  "Emailcc": "sample string 15",
  "EmailBody": "sample string 16",
  "EmailHeaderValidated": true,
  "DistributionListRecipients": [
    {
      "MGAID": 1,
      "CustomerID": 2,
      "EmployeeID": 3,
      "BusinessID": 4,
      "PolicyID": 5
    },
    {
      "MGAID": 1,
      "CustomerID": 2,
      "EmployeeID": 3,
      "BusinessID": 4,
      "PolicyID": 5
    }
  ],
  "EmailSource": "sample string 18",
  "TemplateDataSource": "sample string 19",
  "ReportCategory": {
    "ReportCategoryID": 1,
    "CategoryName": "sample string 2",
    "Visible": true,
    "ReportGroups": []
  },
  "CancelUrl": "sample string 20",
  "LogoUrl": "sample string 21",
  "SelectedSignatureId": "sample string 22",
  "SignatureUrl": "sample string 23",
  "OrderBy": "sample string 24",
  "SortDirection": "sample string 25",
  "StandardDistributionList": {
    "DistributionListID": "e07720bb-2374-4838-ba6e-6d313fa9ad8d",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ReportCategoryID": 1,
    "ReportCategoryName": "sample string 4",
    "ConfigurationData": "sample string 5",
    "CreatedOn": "2026-08-25T17:21:36.8631678+00:00",
    "CreatedBy": 1,
    "ModifiedBy": 1,
    "ModifiedOn": "2026-08-25T17:21:36.8631678+00:00",
    "DeletedDate": "2026-08-25T17:21:36.8631678+00:00",
    "RowSource": "QEA=",
    "DistributionListTypeCode": "sample string 6",
    "CreatedOnString": "sample string 7",
    "ModifiedOnString": "sample string 8",
    "ModifiedByString": "sample string 9",
    "IsCustom": true,
    "ListType": {
      "DisplayOrder": 1,
      "Code": "sample string 2",
      "Display": "sample string 3"
    },
    "MostWeightedSmartDateGUID": "c710c137-719c-445e-abad-67730d42b213"
  },
  "CustomDistributionListData": {
    "DistributionListID": "5d6d771b-e62f-4101-82b7-7c83de476de8",
    "Name": "sample string 2",
    "Description": "sample string 3",
    "ReportCategoryID": 1,
    "ConfigurationData": "sample string 4",
    "CreatedOn": "2026-08-25T17:21:36.863688+00:00",
    "CreatedBy": 1,
    "ModifiedOn": "2026-08-25T17:21:36.863688+00:00",
    "ModifiedBy": 1,
    "DeletedDate": "2026-08-25T17:21:36.863688+00:00",
    "RowSource": "QEA=",
    "DistributionListTypeCode": "sample string 2",
    "SessionID": "sample string 6",
    "CreatedOnString": "sample string 7",
    "ModifiedOnString": "sample string 8",
    "ModifiedByString": "sample string 9",
    "MostWeightedSmartDateGUID": "da2d3fd4-8074-49fa-b760-8523f777eb4c",
    "ListType": {
      "DisplayOrder": 0,
      "Code": null,
      "Display": null
    },
    "IsCustom": true,
    "ReportCategoryName": "sample string 10"
  },
  "TemplateWasSelected": true,
  "SelectedTemplate": "sample string 26",
  "SelectedLocation": 27,
  "TemplateID": "0dfb5c8e-1cc3-4afd-a664-13f7cf247017",
  "Template": "sample string 29",
  "TemplateHasPolicyRelatedFields": true,
  "CanUnsubscribe": true,
  "Title": "sample string 31",
  "Notes": "sample string 32",
  "DeliveryOpt": "sample string 33",
  "ShowEmailAttachTab": true,
  "CreatedBy": 1,
  "CreatedOn": "2026-08-25T17:21:36.8647253+00:00",
  "ModifiedOn": "2026-08-25T17:21:36.8647253+00:00",
  "BlobFileID": 1,
  "IsEmail": true,
  "ContactID": 2,
  "PolicyID": null,
  "ResendEmail": true,
  "UseSendGridApi": true,
  "EmailEventId": "d0740501-d7da-46bb-9032-9013617fcd0e",
  "CampaignGuid": "c8099740-a8ab-4605-af6f-4e877296c84e",
  "EnableOpenTracking": true,
  "EnableClickTracking": true,
  "EnableSpamCheck": true,
  "InsertEventTracker": true,
  "TemplateDocumentDataSource": {
    "DataSourceGroups": [
      1,
      2
    ],
    "SelectedCategoryID": 1
  },
  "TemplateDocumentMetadata": {
    "Locations": [
      1,
      2
    ],
    "Categories": [
      1,
      2
    ],
    "Name": "sample string 1",
    "Description": "sample string 2"
  }
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentSessionData'.

application/xml, text/xml

Sample:

<DocumentSessionData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.BusinessLogic.Documents">
  <BlobFileID>1</BlobFileID>
  <CampaignGuid>c8099740-a8ab-4605-af6f-4e877296c84e</CampaignGuid>
  <CanUnsubscribe>true</CanUnsubscribe>
  <CancelUrl>sample string 20</CancelUrl>
  <CopyMode>true</CopyMode>
  <CreatedBy>1</CreatedBy>
  <CreatedOn>2026-08-25T17:21:36.8647253+00:00</CreatedOn>
  <CustomDistributionListData xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.Contracts.Entities.Reports">
    <d2p1:ConfigurationData>sample string 4</d2p1:ConfigurationData>
    <d2p1:CreatedBy>1</d2p1:CreatedBy>
    <d2p1:CreatedOn>2026-08-25T17:21:36.863688+00:00</d2p1:CreatedOn>
    <d2p1:CreatedOnString>sample string 7</d2p1:CreatedOnString>
    <d2p1:DeletedDate>2026-08-25T17:21:36.863688+00:00</d2p1:DeletedDate>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DistributionListID>5d6d771b-e62f-4101-82b7-7c83de476de8</d2p1:DistributionListID>
    <d2p1:DistributionListTypeCode>sample string 2</d2p1:DistributionListTypeCode>
    <d2p1:ListType xmlns:d3p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.Contracts.Data">
      <d3p1:Code i:nil="true" />
      <d3p1:Display i:nil="true" />
      <d3p1:DisplayOrder>0</d3p1:DisplayOrder>
    </d2p1:ListType>
    <d2p1:ModifiedBy>1</d2p1:ModifiedBy>
    <d2p1:ModifiedByString>sample string 9</d2p1:ModifiedByString>
    <d2p1:ModifiedOn>2026-08-25T17:21:36.863688+00:00</d2p1:ModifiedOn>
    <d2p1:ModifiedOnString>sample string 8</d2p1:ModifiedOnString>
    <d2p1:MostWeightedSmartDateGUID>da2d3fd4-8074-49fa-b760-8523f777eb4c</d2p1:MostWeightedSmartDateGUID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:ReportCategoryID>1</d2p1:ReportCategoryID>
    <d2p1:ReportCategoryName>sample string 10</d2p1:ReportCategoryName>
    <d2p1:RowSource>QEA=</d2p1:RowSource>
    <d2p1:SessionID>sample string 6</d2p1:SessionID>
  </CustomDistributionListData>
  <DataSourceCategoryID>1</DataSourceCategoryID>
  <DeliveryOpt>sample string 33</DeliveryOpt>
  <Description>sample string 7</Description>
  <DistributionListID>904a5872-42a0-42d8-8a3a-d1845298bf23</DistributionListID>
  <DistributionListName>sample string 2</DistributionListName>
  <DistributionListRecipients xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Marketing">
    <d2p1:BulkLetterDistributionRecipients>
      <d2p1:BusinessID>4</d2p1:BusinessID>
      <d2p1:CustomerID>2</d2p1:CustomerID>
      <d2p1:EmployeeID>3</d2p1:EmployeeID>
      <d2p1:MGAID>1</d2p1:MGAID>
      <d2p1:PolicyID>5</d2p1:PolicyID>
    </d2p1:BulkLetterDistributionRecipients>
    <d2p1:BulkLetterDistributionRecipients>
      <d2p1:BusinessID>4</d2p1:BusinessID>
      <d2p1:CustomerID>2</d2p1:CustomerID>
      <d2p1:EmployeeID>3</d2p1:EmployeeID>
      <d2p1:MGAID>1</d2p1:MGAID>
      <d2p1:PolicyID>5</d2p1:PolicyID>
    </d2p1:BulkLetterDistributionRecipients>
  </DistributionListRecipients>
  <DocumentID>5</DocumentID>
  <DocumentName>sample string 6</DocumentName>
  <EditMode>true</EditMode>
  <EmailAcords>
    <DocumentSessionAcordData>
      <AcordNameAsSent>sample string 3</AcordNameAsSent>
      <CertHolders xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </CertHolders>
      <FromAcordEditor>true</FromAcordEditor>
      <ID>1</ID>
    </DocumentSessionAcordData>
    <DocumentSessionAcordData>
      <AcordNameAsSent>sample string 3</AcordNameAsSent>
      <CertHolders xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </CertHolders>
      <FromAcordEditor>true</FromAcordEditor>
      <ID>1</ID>
    </DocumentSessionAcordData>
  </EmailAcords>
  <EmailAttachments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </EmailAttachments>
  <EmailAttachmentsFileNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAttachmentsFileNames>
  <EmailBcc>sample string 14</EmailBcc>
  <EmailBody>sample string 16</EmailBody>
  <EmailEventId>d0740501-d7da-46bb-9032-9013617fcd0e</EmailEventId>
  <EmailFrom>sample string 11</EmailFrom>
  <EmailHeaderValidated>true</EmailHeaderValidated>
  <EmailSource>sample string 18</EmailSource>
  <EmailSubject>sample string 13</EmailSubject>
  <EmailTo>sample string 10</EmailTo>
  <Emailcc>sample string 15</Emailcc>
  <EnableClickTracking>true</EnableClickTracking>
  <EnableOpenTracking>true</EnableOpenTracking>
  <EnableSpamCheck>true</EnableSpamCheck>
  <EntityID>3</EntityID>
  <EntityType>sample string 4</EntityType>
  <InsertEventTracker>true</InsertEventTracker>
  <IsEmail>true</IsEmail>
  <LogoUrl>sample string 21</LogoUrl>
  <ModifiedOn>2026-08-25T17:21:36.8647253+00:00</ModifiedOn>
  <Notes>sample string 32</Notes>
  <OrderBy>sample string 24</OrderBy>
  <ReportCategory xmlns:d2p1="http://schemas.datacontract.org/2004/07/CommonDbApiContracts.Dto.Report">
    <d2p1:CategoryName>sample string 2</d2p1:CategoryName>
    <d2p1:ReportCategoryID>1</d2p1:ReportCategoryID>
    <d2p1:ReportGroups />
    <d2p1:Visible>true</d2p1:Visible>
  </ReportCategory>
  <ResendEmail>true</ResendEmail>
  <SelectedLocation>27</SelectedLocation>
  <SelectedSignatureId>sample string 22</SelectedSignatureId>
  <SelectedTemplate>sample string 26</SelectedTemplate>
  <ShowEmailAttachTab>true</ShowEmailAttachTab>
  <SignatureUrl>sample string 23</SignatureUrl>
  <SortDirection>sample string 25</SortDirection>
  <StandardDistributionList xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Marketing">
    <d2p1:ConfigurationData>sample string 5</d2p1:ConfigurationData>
    <d2p1:CreatedBy>1</d2p1:CreatedBy>
    <d2p1:CreatedOn>2026-08-25T17:21:36.8631678+00:00</d2p1:CreatedOn>
    <d2p1:CreatedOnString>sample string 7</d2p1:CreatedOnString>
    <d2p1:DeletedDate>2026-08-25T17:21:36.8631678+00:00</d2p1:DeletedDate>
    <d2p1:Description>sample string 3</d2p1:Description>
    <d2p1:DistributionListID>e07720bb-2374-4838-ba6e-6d313fa9ad8d</d2p1:DistributionListID>
    <d2p1:DistributionListTypeCode>sample string 6</d2p1:DistributionListTypeCode>
    <d2p1:ListType xmlns:d3p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.Contracts.Data">
      <d3p1:Code>sample string 2</d3p1:Code>
      <d3p1:Display>sample string 3</d3p1:Display>
      <d3p1:DisplayOrder>1</d3p1:DisplayOrder>
    </d2p1:ListType>
    <d2p1:ModifiedBy>1</d2p1:ModifiedBy>
    <d2p1:ModifiedByString>sample string 9</d2p1:ModifiedByString>
    <d2p1:ModifiedOn>2026-08-25T17:21:36.8631678+00:00</d2p1:ModifiedOn>
    <d2p1:ModifiedOnString>sample string 8</d2p1:ModifiedOnString>
    <d2p1:MostWeightedSmartDateGUID>c710c137-719c-445e-abad-67730d42b213</d2p1:MostWeightedSmartDateGUID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:ReportCategoryID>1</d2p1:ReportCategoryID>
    <d2p1:ReportCategoryName>sample string 4</d2p1:ReportCategoryName>
    <d2p1:RowSource>QEA=</d2p1:RowSource>
  </StandardDistributionList>
  <Template>sample string 29</Template>
  <TemplateDataSource>sample string 19</TemplateDataSource>
  <TemplateDocumentDataSource>
    <DataSourceGroups xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </DataSourceGroups>
    <SelectedCategoryID>1</SelectedCategoryID>
  </TemplateDocumentDataSource>
  <TemplateDocumentMetadata>
    <Categories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </Categories>
    <Description>sample string 2</Description>
    <Locations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </Locations>
    <Name>sample string 1</Name>
  </TemplateDocumentMetadata>
  <TemplateHasPolicyRelatedFields>true</TemplateHasPolicyRelatedFields>
  <TemplateID>0dfb5c8e-1cc3-4afd-a664-13f7cf247017</TemplateID>
  <Title>sample string 31</Title>
  <UseSendGridApi>true</UseSendGridApi>
  <UseSystemEmailFrom>true</UseSystemEmailFrom>
  <contextInfo>
    <Elements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringint>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>2</d3p1:Value>
      </d3p1:KeyValueOfstringint>
      <d3p1:KeyValueOfstringint>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>4</d3p1:Value>
      </d3p1:KeyValueOfstringint>
    </Elements>
    <GuidElements xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringguid>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>e7011911-46b7-4f2c-93c1-88970140e2da</d3p1:Value>
      </d3p1:KeyValueOfstringguid>
      <d3p1:KeyValueOfstringguid>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>aa7ebbc3-8cea-4e6c-a8ff-2c71bb99996a</d3p1:Value>
      </d3p1:KeyValueOfstringguid>
    </GuidElements>
  </contextInfo>
</DocumentSessionData>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.