You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This setting is our <ahref="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Template Engine</a>, that supports multiple templates, versioning and more. Previously, we had a Template App, now called the <ahref="#template">Legacy Template App</a>.
526
+
This setting refers to SendGrid's <ahref="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html">transactional templates</a>. SendGrid supports versioning, and the ability to create multiple transactional templates. Previously, we had a Template App, which is now referred to as the <ahref="#template">Legacy Template App</a>.
527
527
{% endinfo %}
528
528
529
529
530
-
<p>Uses a template created with the <ahref="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">Template Engine</a> when sending an email. More information on usage of the Template Engine with the SMTP API may be found in the <ahref="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html">Template Engine API Reference</a>.
530
+
<p>Uses a <ahref="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html">transactional template</a> when sending an email. More information on using transactional templates with the SMTP API may be found in the <ahref="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html">transactional templates API Reference</a>.
This setting is our original Email Template app, today we have a more full featured <ahref="#templates">Template Engine</a>, which supports multiple templates, versioning and more.
573
+
This setting refers to our original Email Template app. We now support more fully featured <ahref="#templates">transactional templates</a>. You may create multiple transactional templates that allow for versioning, in addition to several other features.
Copy file name to clipboardexpand all lines: source/API_Reference/SMTP_API/substitution_tags.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -149,7 +149,7 @@ Example: **substitution1** replaced by **section1** replaced by **substitution2*
149
149
{% anchor h2 %}
150
150
SendGrid Defined Substitution Tags
151
151
{% endanchor %}
152
-
While the tags above are tags that you define at the time of your send in the SMTPAPI headers, SendGrid also offers [Unsubscribe Groups tags]({{root_url}}/User_Guide/Templates/create_edit.html#-Unsubscribe-Substitution-Tags) that have been pre-defined for you. You can use these tags within the content of your email and you do not have to, and should not, define them.
152
+
While the tags above are tags that you define at the time of your send in the SMTPAPI headers, SendGrid also offers [Unsubscribe Groups tags]({{root_url}}/User_Guide/Transactional_Templates/create_edit.html#-Unsubscribe-Substitution-Tags) that have been pre-defined for you. You can use these tags within the content of your email and you do not have to, and should not, define them.
Copy file name to clipboardexpand all lines: source/API_Reference/Web_API/filter_settings.md
+25-25
Original file line number
Diff line number
Diff line change
@@ -15,16 +15,16 @@ For a more detailed description of each of the Filters below, please visit the [
15
15
All calls to change filter settings are made to the [filter.setup endpoint.]({{root_url}}/API_Reference/Web_API/filter_commands.html#-Setup-App)
16
16
17
17
{% anchor h2 %}
18
-
Address Whitelist
18
+
Address Whitelist
19
19
{% endanchor %}
20
20
21
21
*Name - `addresswhitelist`*
22
22
23
23
{% info %}
24
-
When using this call, you must define all emails & domains here. Using this call will overwrite any current settings for this filter. This would also be how you remove an entry, by excluding if from the call.
24
+
When using this call, you must define all emails & domains here. Using this call will overwrite any current settings for this filter. This would also be how you remove an entry, by excluding if from the call.
25
25
{% endinfo %}
26
-
{% parameters addresswhitelist %}
27
-
26
+
{% parameters addresswhitelist %}
27
+
28
28
{% parameter name yes 'addresswhitelist' 'The name of the setting.' %}
@@ -46,13 +46,13 @@ When using this call, you must define all emails & domains here. Using this call
46
46
* * * * *
47
47
48
48
{% anchor h2 %}
49
-
BCC "Blind Carbon Copy"
49
+
BCC "Blind Carbon Copy"
50
50
{% endanchor %}
51
51
52
52
*Name - `bcc`*
53
53
54
-
{% parameters bcc %}
55
-
54
+
{% parameters bcc %}
55
+
56
56
{% parameter name yes 'bcc' 'The name of the setting.' %}
57
57
{% parameter email yes 'An email address to be the BCC recipient.' '[email protected]' %}
58
58
{% endparameters %}
@@ -74,13 +74,13 @@ BCC "Blind Carbon Copy"
74
74
* * * * *
75
75
76
76
{% anchor h2 %}
77
-
Click Tracking
77
+
Click Tracking
78
78
{% endanchor %}
79
79
80
80
*Name - `clicktrack`*
81
81
82
-
{% parameters clicktrack %}
83
-
82
+
{% parameters clicktrack %}
83
+
84
84
{% parameter name yes 'clicktrack' 'The name of the setting.' %}
85
85
{% parameter enable_text yes 'Enable click tracking in plain text emails.' '0 or 1' %}
86
86
{% endparameters %}
@@ -102,13 +102,13 @@ Click Tracking
102
102
* * * * *
103
103
104
104
{% anchor h2 %}
105
-
DKIM
105
+
DKIM
106
106
{% endanchor %}
107
107
108
108
*Name - `dkim`*
109
109
110
-
{% parameters dkim %}
111
-
110
+
{% parameters dkim %}
111
+
112
112
{% parameter name yes 'dkim' 'The name of the setting.' %}
113
113
{% parameter domain yes 'The domain to sign messages as.' 'example.com' %}
114
114
{% parameter use_from no 'If enabled, the domain in the From: header of the email will be used to sign your DKIM.' '0 or 1' %}
@@ -131,16 +131,16 @@ DKIM
131
131
* * * * *
132
132
133
133
{% anchor h2 -Email-Templates %}
134
-
Legacy Email Templates
134
+
Legacy Email Templates
135
135
{% endanchor %}
136
136
137
137
*Name - `template`*
138
138
139
139
{% warning %}
140
-
This setting is our original Email Template app, today we have a more full featured [Template Engine]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html), which supports multiple templates, versioning and more. Its settings, however, are controlled using a [separate API]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html).
140
+
This setting is our original Email Template app, today we have more full featured [transactional templates]({{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html), with support for multiple templates, and versioning, and many other helpful features. Its settings, however, are controlled using a [separate API]({{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html).
141
141
{% endwarning %}
142
-
{% parameters template %}
143
-
142
+
{% parameters template %}
143
+
144
144
{% parameter name yes 'template' 'The name of the setting.' %}
145
145
{% parameter text/html yes 'A string that holds the template html body.' '\<html\>\<head\>\</head\>\<body bgcolor='pink'\>\<div style='width:200px' bgcolor='\#FFF'\>\<% body %\>\</div\>\</body\>\</html\>' %}
146
146
{% endparameters %}
@@ -162,13 +162,13 @@ This setting is our original Email Template app, today we have a more full featu
162
162
* * * * *
163
163
164
164
{% anchor h2 %}
165
-
Event Notification
165
+
Event Notification
166
166
{% endanchor %}
167
167
168
168
*Name - `eventnotify`*
169
169
170
170
{% info %}
171
-
All fields except version are required for each call.
171
+
All fields except version are required for each call.
172
172
{% endinfo %}
173
173
174
174
@@ -209,7 +209,7 @@ All fields except version are required for each call.
209
209
* * * * *
210
210
211
211
{% anchor h2 %}
212
-
Footer
212
+
Footer
213
213
{% endanchor %}
214
214
215
215
*Name - `footer`*
@@ -240,7 +240,7 @@ You must provide either text/html or text/plain, or both, to avoid receiving a "
240
240
* * * * *
241
241
242
242
{% anchor h2 %}
243
-
Google Analytics
243
+
Google Analytics
244
244
{% endanchor %}
245
245
246
246
*Name - `ganalytics`*
@@ -274,7 +274,7 @@ At least one of the optional parameters needs to be passed to avoid a "missing p
274
274
* * * * *
275
275
276
276
{% anchor h2 %}
277
-
SPAM Filter Checker
277
+
SPAM Filter Checker
278
278
{% endanchor %}
279
279
280
280
*Name - `spamcheck`*
@@ -304,7 +304,7 @@ SPAM Filter Checker
304
304
* * * * *
305
305
306
306
{% anchor h2 %}
307
-
Subscription Tracking
307
+
Subscription Tracking
308
308
{% endanchor %}
309
309
310
310
*Name - `subscriptiontrack`*
@@ -338,7 +338,7 @@ You must pass at least one of the optional params in order to avoid the "missing
The transactional templates API lets you programmatically [create and manage
11
+
templates]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/templates.html) for your transactional email. You may [version these templates]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/versions.html), then [send them through the existing SendGrid API]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html).
Templates are re-usable email layouts, that may be created and interacted with through the API. These are intended to be a specific type of message, such as 'Weekly Product Update'.
Templates may have multiple versions with different content, these may be changed and activated through the API. These allow split testing, multiple languages of the same template, etc.
The [SMTP API]({{ root_url }}/API_Reference/SMTP_API/index.html) is used to send templated email through SendGrid. The Web API with the [x-smtpapi parameter]({{ root_url }}/API_Reference/Web_API/mail.html#-send) can also be used.
The Template Engine API lets you programmatically create and manage templates for your transactional email.
10
+
The transactional templates API lets you programmatically create and manage templates for your transactional email.
11
11
12
12
{% info %}
13
13
Each user can have up to 300 templates.
14
14
{% endinfo %}
15
15
16
16
{% info %}
17
-
Templates created in Template Engine are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
17
+
Transactional templates are account and subuser specific. Templates created on a parent account will not be accessible from the subuser accounts.
method. Versions are returned as nested resources of the template
16
16
resource.
17
17
18
-
To set which version is active, use the [version PATCH]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/versions.html#-PATCH) method to set the
18
+
To set which version is active, use the [version PATCH]({{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/versions.html#-PATCH) method to set the
Copy file name to clipboardexpand all lines: source/API_Reference/index.html
+1-1
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ <h3>Web API</h3>
19
19
<p>If SMTP is not used, we also offer a simple <ahref="{{root_url}}/API_Reference/Web_API/mail.html">Web API mail method</a> to send email. </p>
20
20
21
21
<h3>Web API V3</h3>
22
-
<p>Our V3 Web API provides functionality for <ahref="{{root_url}}/API_Reference/Web_API_v3/Suppression_Management/index.html">managing user unsubscribes</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">templating emails</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/IP_Management/index.html">managing IP addresses</a>, and <ahref="{{root_url}}/API_Reference/Web_API_v3/Settings/enforced_tls.html">enforcing TLS</a>.</p>
22
+
<p>Our V3 Web API provides functionality for <ahref="{{root_url}}/API_Reference/Web_API_v3/Suppression_Management/index.html">managing user unsubscribes</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html">templating emails</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/IP_Management/index.html">managing IP addresses</a>, and <ahref="{{root_url}}/API_Reference/Web_API_v3/Settings/enforced_tls.html">enforcing TLS</a>.</p>
23
23
24
24
<h3>Marketing Campaigns API</h3>
25
25
<p>The SendGrid Marketing Email API provides developers with the ability to <ahref="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html">manage marketing emails</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html">lists</a>, <ahref="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html">identities</a>, and <ahref="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html">schedule delivery events</a></p>
Copy file name to clipboardexpand all lines: source/Classroom/Basics/API/how_do_i_integrate_with_sendgrid.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ There are many different ways to use SendGrid’s email services so it all
17
17
18
18
-[SMTP](http://support.sendgrid.com/hc/en-us/articles/202821898-What-is-SMTP-) - Send using a desktop mail client, or existing program/service with [your smtp credentials](http://support.sendgrid.com/hc/en-us/articles/200328026-What-are-my-settings-for-SMTP-integration-).
19
19
-[Web API](https://sendgrid.com/docs/API_Reference/Web_API/index.html) - Send from your app using [your api key](http://support.sendgrid.com/hc/en-us/articles/200181818-What-is-my-API-key-). Check out our [API Guide](http://go.sendgrid.com/rs/sendgrid/images/SendGrid_API_Guide-101.pdf) for more info.
20
-
-[Email Marketing App and API](https://sendgrid.com/docs/Marketing_Emails/index.html) - Send from our content creation UI and manage your lists via the website.
20
+
-[Email Marketing App and API](https://sendgrid.com/docs/User_Guide/Legacy_Features/Marketing_Emails/index.html) - Send from our content creation UI and manage your lists via the website.
Copy file name to clipboardexpand all lines: source/Classroom/Basics/API/what_are_the_sendgrid_apis_and_what_do_they_do.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -31,4 +31,4 @@ The SendGrid APIs allow you to interact with our system in a number of different
31
31
32
32
33
33
34
-
**Marketing Email API** – The Marketing Email API allows you to interact with our Marketing Email app without having to log into sendgrid.com. You can upload and manage recipient lists, Marketing Email content, and manage sender identities. Please visit our [SendGrid Marketing Email API Documentation](http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/index.html) page for more information or our [SendGrid Interactive Documentation](http://sendgrid.com/docs/api_workshop.html) for help building Marketing Email API calls.
34
+
**Marketing Email API** – The Marketing Email API allows you to interact with our Marketing Email app without having to log into sendgrid.com. You can upload and manage recipient lists, Marketing Email content, and manage sender identities. Please visit our [SendGrid Marketing Email API Documentation](http://sendgrid.com/docs/API_Reference/Web_API/Legacy_Features/Marketing_Emails_API/index.html) page for more information or our [SendGrid Interactive Documentation](http://sendgrid.com/docs/api_workshop.html) for help building Marketing Email API calls.
0 commit comments