| Requires any of the roles: | Client, Admin, Partner |
| All Verbs | /sendmail/sendgrid/single |
|---|
"use strict";
export class EmailAddress {
/** @param {{Name?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Email;
}
export class SendGridSingleMailRequest {
/** @param {{To?:EmailAddress,Subject?:string,TemplateId?:string,ReplyToEmail?:EmailAddress,FromEmail?:EmailAddress,PlaintText?:string,HtmlText?:string,APIKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {EmailAddress} */
To;
/** @type {string} */
Subject;
/** @type {string} */
TemplateId;
/** @type {EmailAddress} */
ReplyToEmail;
/** @type {EmailAddress} */
FromEmail;
/** @type {string} */
PlaintText;
/** @type {string} */
HtmlText;
/** @type {string} */
APIKey;
}
JavaScript SendGridSingleMailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /sendmail/sendgrid/single HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SendGridSingleMailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceInterface">
<APIKey>String</APIKey>
<FromEmail xmlns:d2p1="http://schemas.datacontract.org/2004/07/SendGrid.Helpers.Mail">
<d2p1:Email>String</d2p1:Email>
<d2p1:Name>String</d2p1:Name>
</FromEmail>
<HtmlText>String</HtmlText>
<PlaintText>String</PlaintText>
<ReplyToEmail xmlns:d2p1="http://schemas.datacontract.org/2004/07/SendGrid.Helpers.Mail">
<d2p1:Email>String</d2p1:Email>
<d2p1:Name>String</d2p1:Name>
</ReplyToEmail>
<Subject>String</Subject>
<TemplateId>String</TemplateId>
<To xmlns:d2p1="http://schemas.datacontract.org/2004/07/SendGrid.Helpers.Mail">
<d2p1:Email>String</d2p1:Email>
<d2p1:Name>String</d2p1:Name>
</To>
</SendGridSingleMailRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />