POST api/Emails/Send
Request Information
URI Parameters
None.
Body Parameters
EmailModel| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | globally unique identifier |
None. |
|
| EventId | integer |
None. |
|
| To | Collection of string |
None. |
|
| CC | string |
None. |
|
| Subject | string |
None. |
|
| Body | string |
None. |
|
| ParameterKeyPathFileToAttach | string |
None. |
|
| ParameterKeyEmbeddedImage | string |
None. |
|
| ZipFile | Collection of Object |
None. |
|
| ZipFileName | string |
None. |
|
| Attachments | Collection of Object |
None. |
Request Formats
application/json, text/json
Sample:
{
"APIKey": "6a4c2b0f-78c6-48c0-8903-2ee50ed6aad8",
"EventId": 1,
"To": [
"sample string 1",
"sample string 2"
],
"CC": "sample string 2",
"Subject": "sample string 3",
"Body": "sample string 4",
"ParameterKeyPathFileToAttach": "sample string 5",
"ParameterKeyEmbeddedImage": "sample string 6",
"ZipFile": null,
"ZipFileName": "sample string 7",
"Attachments": null
}
application/xml, text/xml
Sample:
<EmailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Connect.Model">
<APIKey>6a4c2b0f-78c6-48c0-8903-2ee50ed6aad8</APIKey>
<Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Net.Mail" i:nil="true" />
<Body>sample string 4</Body>
<CC>sample string 2</CC>
<EventId>1</EventId>
<ParameterKeyEmbeddedImage>sample string 6</ParameterKeyEmbeddedImage>
<ParameterKeyPathFileToAttach>sample string 5</ParameterKeyPathFileToAttach>
<Subject>sample string 3</Subject>
<To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</To>
<ZipFile xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ionic.Zip" i:nil="true" />
<ZipFileName>sample string 7</ZipFileName>
</EmailModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |