digitaluapi

<back to all web services

SendMailRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/sendmailSends an email
SendMailRequest Parameters:
NameParameterData TypeRequiredDescription
FromAddressbodystringNoEmail address of sender. If it is not set the a default address will be used.
RecipientsbodyIEnumerable<string>YesList of recipient email addresses
SubjectbodystringYesEmail subject
BodybodystringNoPlain text body. Either this or HtmlBody is required
HtmlBodybodystringNoHtml body. Either this or Body is required
Attachmentsbodystring[]NoEmail attachments
AttachmentsObjectbodyAttachment[]NoEmail attachments
AttachmentStreamsbodyAttachmentStream[]NoAttachment streams
TemplateSubstitutionsbodyDictionary<string, string>NoTemplate substitutions
TemplateIdbodystringNoTemplate Id
BccbodyIEnumerable<string>NoList of BCC email addresses
CcbodyIEnumerable<string>NoList of CC email addresses
Attachment Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
TypeformstringNo
FilenameformstringNo
DispositionformstringNo
ContentIdformstringNo
AttachmentStream Parameters:
NameParameterData TypeRequiredDescription
StreamformStreamNo
NameformstringNo
TypeformstringNo
DispositionformstringNo
ContentidformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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

{
	
}