| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/sendmail | Sends an email |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FromAddress | body | string | No | Email address of sender. If it is not set the a default address will be used. |
| Recipients | body | IEnumerable<string> | Yes | List of recipient email addresses |
| Subject | body | string | Yes | Email subject |
| Body | body | string | No | Plain text body. Either this or HtmlBody is required |
| HtmlBody | body | string | No | Html body. Either this or Body is required |
| Attachments | body | string[] | No | Email attachments |
| AttachmentsObject | body | Attachment[] | No | Email attachments |
| AttachmentStreams | body | AttachmentStream[] | No | Attachment streams |
| TemplateSubstitutions | body | Dictionary<string, string> | No | Template substitutions |
| TemplateId | body | string | No | Template Id |
| Bcc | body | IEnumerable<string> | No | List of BCC email addresses |
| Cc | body | IEnumerable<string> | No | List of CC email addresses |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Content | form | string | No | |
| Type | form | string | No | |
| Filename | form | string | No | |
| Disposition | form | string | No | |
| ContentId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stream | form | Stream | No | |
| Name | form | string | No | |
| Type | form | string | No | |
| Disposition | form | string | No | |
| Contentid | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /communication/sendmail HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FromAddress: String,
Subject: String,
Body: String,
HtmlBody: String,
Attachments:
[
String
],
AttachmentsObject:
[
{
Content: String,
Type: String,
Filename: String,
Disposition: String,
ContentId: String
}
],
AttachmentStreams:
[
{
Name: String,
Type: String,
Disposition: String,
Contentid: String
}
],
TemplateSubstitutions:
{
String: String
},
TemplateId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}