| Requires any of the roles: | Client, Admin, Partner |
| All Verbs | /sendmail/sendgridtemplate |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | query | EmailAddress | No | |
| Subject | query | string | No | |
| TemplatesId | query | string | No | |
| APIKey | query | string | No | |
| Personalizations | query | List<Personalization> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Tos | form | List<EmailAddress> | No | |
| Ccs | form | List<EmailAddress> | No | |
| Bccs | form | List<EmailAddress> | No | |
| From | form | EmailAddress | No | |
| Subject | form | string | No | |
| Headers | form | Dictionary<string, string> | No | |
| Substitutions | form | Dictionary<string, string> | No | |
| CustomArgs | form | Dictionary<string, string> | No | |
| SendAt | form | long? | No | |
| TemplateData | form | Object | 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 /sendmail/sendgridtemplate HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
From:
{
Name: String,
Email: String
},
Subject: String,
TemplatesId: String,
APIKey: String,
Personalizations:
[
{
Tos:
[
{
Name: String,
Email: String
}
],
Ccs:
[
{
Name: String,
Email: String
}
],
Bccs:
[
{
Name: String,
Email: String
}
],
From:
{
Name: String,
Email: String
},
Subject: String,
Headers:
{
String: String
},
Substitutions:
{
String: String
},
CustomArgs:
{
String: String
},
SendAt: 0,
TemplateData: {}
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}