digitaluapi

<back to all web services

SendGridMailTemplateRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
All Verbs/sendmail/sendgridtemplate
SendGridMailTemplateRequest Parameters:
NameParameterData TypeRequiredDescription
FromqueryEmailAddressNo
SubjectquerystringNo
TemplatesIdquerystringNo
APIKeyquerystringNo
PersonalizationsqueryList<Personalization>No
EmailAddress Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
EmailformstringNo
Personalization Parameters:
NameParameterData TypeRequiredDescription
TosformList<EmailAddress>No
CcsformList<EmailAddress>No
BccsformList<EmailAddress>No
FromformEmailAddressNo
SubjectformstringNo
HeadersformDictionary<string, string>No
SubstitutionsformDictionary<string, string>No
CustomArgsformDictionary<string, string>No
SendAtformlong?No
TemplateDataformObjectNo

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 /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

{
	
}