POST api/emails/requests

This method should be used to submit a new email request for one or more properties.

Requires Authorization!

Request Information

URI Parameters

None.

Body Parameters

Instance of Request model

Name	Type	Additional information
TemplateId	integer	None.
ToEmails	Collection of string	None.
EmailSubject	string	None.
TargetTownshipId	integer	None.
AnalysisTaxYear	integer	None.
TargetUserPropertyIds	Collection of integer	None.
TargetProspectsOnly	boolean	None.
EmailAttachmentUrls	Collection of string	None.
EmailCustomContent	string	None.
IsHtml	boolean	None.
CaseId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "templateId": 1,
  "toEmails": [
    "sample string 1",
    "sample string 2"
  ],
  "emailSubject": "sample string 1",
  "targetTownshipId": 1,
  "analysisTaxYear": 1,
  "targetUserPropertyIds": [
    1,
    2
  ],
  "targetProspectsOnly": true,
  "emailAttachmentUrls": [
    "sample string 1",
    "sample string 2"
  ],
  "emailCustomContent": "sample string 3",
  "isHtml": true,
  "caseId": 1
}

text/html

Sample:

{"templateId":1,"toEmails":["sample string 1","sample string 2"],"emailSubject":"sample string 1","targetTownshipId":1,"analysisTaxYear":1,"targetUserPropertyIds":[1,2],"targetProspectsOnly":true,"emailAttachmentUrls":["sample string 1","sample string 2"],"emailCustomContent":"sample string 3","isHtml":true,"caseId":1}

application/xml, text/xml

Sample:

<EmailRequestBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Emails">
  <AnalysisTaxYear>1</AnalysisTaxYear>
  <CaseId>1</CaseId>
  <EmailAttachmentUrls xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAttachmentUrls>
  <EmailCustomContent>sample string 3</EmailCustomContent>
  <EmailSubject>sample string 1</EmailSubject>
  <IsHtml>true</IsHtml>
  <TargetProspectsOnly>true</TargetProspectsOnly>
  <TargetTownshipId>1</TargetTownshipId>
  <TargetUserPropertyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </TargetUserPropertyIds>
  <TemplateId>1</TemplateId>
  <ToEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ToEmails>
</EmailRequestBindingModel>

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 'EmailRequestBindingModel'.

Response Information

Resource Description

Instance of Response

EmailRequestResponseModel

Name	Description	Type	Additional information
RequestId		integer	None.
EmailCount		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "requestId": 1,
  "emailCount": 2
}

text/html

Sample:

{"requestId":1,"emailCount":2}

application/xml, text/xml

Sample:

<EmailRequestResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Emails">
  <EmailCount>2</EmailCount>
  <RequestId>1</RequestId>
</EmailRequestResponseModel>