Skip to content

Commit 4ac9d5b

Browse files
committed
Merge branch 'develop' of github.com:sendgrid/docs into develop
2 parents e834be5 + 9f21c7a commit 4ac9d5b

27 files changed

+134
-117
lines changed

source/API_Reference/SMTP_API/apps.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -523,11 +523,11 @@ <h4>Example X-SMTPAPI Header Value</h4>
523523
{% endanchor %}
524524

525525
{% info %}
526-
This setting is our <a href="{{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 <a href="#template">Legacy Template App</a>.
526+
This setting refers to SendGrid's <a href="{{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 <a href="#template">Legacy Template App</a>.
527527
{% endinfo %}
528528

529529

530-
<p>Uses a template created with the <a href="{{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 <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/smtpapi.html">Template Engine API Reference</a>.
530+
<p>Uses a <a href="{{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 <a href="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html">transactional templates API Reference</a>.
531531

532532
<table class="table table-striped table-bordered">
533533
<tbody>
@@ -570,7 +570,7 @@ <h4>Example X-SMTPAPI Header Value</h4>
570570
{% endanchor %}
571571

572572
{% warning %}
573-
This setting is our original Email Template app, today we have a more full featured <a href="#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 <a href="#templates">transactional templates</a>. You may create multiple transactional templates that allow for versioning, in addition to several other features.
574574
{% endwarning %}
575575

576576

source/API_Reference/SMTP_API/substitution_tags.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ Example: **substitution1** replaced by **section1** replaced by **substitution2*
149149
{% anchor h2 %}
150150
SendGrid Defined Substitution Tags
151151
{% 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.
153153

154154

155155

source/API_Reference/Web_API/filter_settings.md

+25-25
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,16 @@ For a more detailed description of each of the Filters below, please visit the [
1515
All calls to change filter settings are made to the [filter.setup endpoint.]({{root_url}}/API_Reference/Web_API/filter_commands.html#-Setup-App)
1616

1717
{% anchor h2 %}
18-
Address Whitelist
18+
Address Whitelist
1919
{% endanchor %}
2020

2121
*Name - `addresswhitelist`*
2222

2323
{% 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.
2525
{% endinfo %}
26-
{% parameters addresswhitelist %}
27-
26+
{% parameters addresswhitelist %}
27+
2828
{% parameter name yes 'addresswhitelist' 'The name of the setting.' %}
2929
{% parameter list yes 'A list of email addresses or domains.' 'list[]=[email protected]&list[]=[email protected]' %}
3030
{% endparameters %}
@@ -46,13 +46,13 @@ When using this call, you must define all emails & domains here. Using this call
4646
* * * * *
4747

4848
{% anchor h2 %}
49-
BCC "Blind Carbon Copy"
49+
BCC "Blind Carbon Copy"
5050
{% endanchor %}
5151

5252
*Name - `bcc`*
5353

54-
{% parameters bcc %}
55-
54+
{% parameters bcc %}
55+
5656
{% parameter name yes 'bcc' 'The name of the setting.' %}
5757
{% parameter email yes 'An email address to be the BCC recipient.' '[email protected]' %}
5858
{% endparameters %}
@@ -74,13 +74,13 @@ BCC "Blind Carbon Copy"
7474
* * * * *
7575

7676
{% anchor h2 %}
77-
Click Tracking
77+
Click Tracking
7878
{% endanchor %}
7979

8080
*Name - `clicktrack`*
8181

82-
{% parameters clicktrack %}
83-
82+
{% parameters clicktrack %}
83+
8484
{% parameter name yes 'clicktrack' 'The name of the setting.' %}
8585
{% parameter enable_text yes 'Enable click tracking in plain text emails.' '0 or 1' %}
8686
{% endparameters %}
@@ -102,13 +102,13 @@ Click Tracking
102102
* * * * *
103103

104104
{% anchor h2 %}
105-
DKIM
105+
DKIM
106106
{% endanchor %}
107107

108108
*Name - `dkim`*
109109

110-
{% parameters dkim %}
111-
110+
{% parameters dkim %}
111+
112112
{% parameter name yes 'dkim' 'The name of the setting.' %}
113113
{% parameter domain yes 'The domain to sign messages as.' 'example.com' %}
114114
{% 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
131131
* * * * *
132132

133133
{% anchor h2 -Email-Templates %}
134-
Legacy Email Templates
134+
Legacy Email Templates
135135
{% endanchor %}
136136

137137
*Name - `template`*
138138

139139
{% 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).
141141
{% endwarning %}
142-
{% parameters template %}
143-
142+
{% parameters template %}
143+
144144
{% parameter name yes 'template' 'The name of the setting.' %}
145145
{% 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\>' %}
146146
{% endparameters %}
@@ -162,13 +162,13 @@ This setting is our original Email Template app, today we have a more full featu
162162
* * * * *
163163

164164
{% anchor h2 %}
165-
Event Notification
165+
Event Notification
166166
{% endanchor %}
167167

168168
*Name - `eventnotify`*
169169

170170
{% info %}
171-
All fields except version are required for each call.
171+
All fields except version are required for each call.
172172
{% endinfo %}
173173

174174

@@ -209,7 +209,7 @@ All fields except version are required for each call.
209209
* * * * *
210210

211211
{% anchor h2 %}
212-
Footer
212+
Footer
213213
{% endanchor %}
214214

215215
*Name - `footer`*
@@ -240,7 +240,7 @@ You must provide either text/html or text/plain, or both, to avoid receiving a "
240240
* * * * *
241241

242242
{% anchor h2 %}
243-
Google Analytics
243+
Google Analytics
244244
{% endanchor %}
245245

246246
*Name - `ganalytics`*
@@ -274,7 +274,7 @@ At least one of the optional parameters needs to be passed to avoid a "missing p
274274
* * * * *
275275

276276
{% anchor h2 %}
277-
SPAM Filter Checker
277+
SPAM Filter Checker
278278
{% endanchor %}
279279

280280
*Name - `spamcheck`*
@@ -304,7 +304,7 @@ SPAM Filter Checker
304304
* * * * *
305305

306306
{% anchor h2 %}
307-
Subscription Tracking
307+
Subscription Tracking
308308
{% endanchor %}
309309

310310
*Name - `subscriptiontrack`*
@@ -338,7 +338,7 @@ You must pass at least one of the optional params in order to avoid the "missing
338338
* * * * *
339339

340340
{% anchor h2 %}
341-
SendGrid for New Relic
341+
SendGrid for New Relic
342342
{% endanchor %}
343343

344344
*Name - `newrelic`*
@@ -366,7 +366,7 @@ SendGrid for New Relic
366366
* * * * *
367367

368368
{% anchor h2 %}
369-
Sendwithus
369+
Sendwithus
370370
{% endanchor %}
371371

372372
*Name - `sendwithus`*

source/API_Reference/Web_API_v3/Template_Engine/index.md

-17
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
layout: page
3+
title: Transactional Templates Overview
4+
weight: 100
5+
alias: /API_Reference/Web_API_v3/Transactional_Templates/index.html
6+
navigation:
7+
show: true
8+
---
9+
10+
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).
12+
13+
**[Templates]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/templates.html)**
14+
15+
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'.
16+
17+
**[Versions]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/versions.html)**
18+
19+
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.
20+
21+
**[Sending Transactional Templates]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html)**
22+
23+
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.

source/API_Reference/Web_API_v3/Template_Engine/smtpapi.md source/API_Reference/Web_API_v3/Transactional_Templates/smtpapi.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: page
3-
title: Using Template Engine with SMTP API
4-
alias: /API_Reference/Web_API_v3/Template_Engine/smtpapi.html
3+
title: Using Transactional Templates With The SMTP API
4+
alias: /API_Reference/Web_API_v3/Transactional_Templates/smtpapi.html
55
navigation:
66
show: true
77
---
@@ -10,8 +10,8 @@ navigation:
1010
Enabling a Template
1111
{% endanchor %}
1212

13-
To use a Template Engine template when you send, enable the `templates`
14-
filter and set the `template_id` to one of your Template Engine templates.
13+
To use a transactional template when you send, enable the `templates`
14+
filter and set the `template_id` to one of your transactional templates.
1515

1616
Example
1717
{% codeblock lang:json %}
@@ -33,7 +33,7 @@ call]({{root_url}}/API_Reference/Web_API/mail.html#-send).
3333

3434
{% info %}
3535
Make sure that the version of the template you want to use is set to active
36-
by using the [activate endpoint]({{ root_url }}/API_Reference/Web_API_v3/Template_Engine/versions.html#-POST) or by activating it in the
36+
by using the [activate endpoint]({{ root_url }}/API_Reference/Web_API_v3/Transactional_Templates/versions.html#-POST) or by activating it in the
3737
UI.
3838
{% endinfo %}
3939

@@ -43,8 +43,8 @@ UI.
4343
Body and Subject Tags
4444
{% endanchor %}
4545

46-
Enabling a Template Engine template means that the `subject` and `body`
47-
content of your message will behave differently.
46+
Enabling a transactional template means that the `subject` and `body`
47+
content of your message will behave differently.
4848

4949
If you want only the message's content to be displayed, populate only the token in the template's field.
5050
If you want only the template's content to be displayed, leave the message field (subject or body) empty, and the template will populate.

source/API_Reference/Web_API_v3/Template_Engine/templates.md source/API_Reference/Web_API_v3/Transactional_Templates/templates.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
layout: page
33
title: Templates
44
weight: 100
5-
alias: /API_Reference/Web_API_v3/Template_Engine/templates.html
5+
alias: /API_Reference/Web_API_v3/Transactional_Templates/templates.html
66
navigation:
77
show: true
88
---
99

10-
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.
1111

1212
{% info %}
1313
Each user can have up to 300 templates.
1414
{% endinfo %}
1515

1616
{% 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.
1818
{% endinfo %}
1919

2020
* * * * *

source/API_Reference/Web_API_v3/Template_Engine/versions.md source/API_Reference/Web_API_v3/Transactional_Templates/versions.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
layout: page
33
title: Versions
44
weight: 90
5-
alias: /API_Reference/Web_API_v3/Template_Engine/versions.html
5+
alias: /API_Reference/Web_API_v3/Transactional_Templates/versions.html
66
navigation:
77
show: true
88
---
99

10-
Each template can have multiple versions, with different subjects and
10+
Each template can have multiple versions, with different subjects and
1111
content for each version.
1212

1313
To retrieve all versions of a template, call the [template
14-
GET]({{root_url}}/API_Reference/Web_API_v3/Template_Engine/templates.html#-GET)
14+
GET]({{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/templates.html#-GET)
1515
method. Versions are returned as nested resources of the template
1616
resource.
1717

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
1919
active field to 1.
2020

2121
{% info %}

source/API_Reference/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h3>Web API</h3>
1919
<p>If SMTP is not used, we also offer a simple <a href="{{root_url}}/API_Reference/Web_API/mail.html">Web API mail method</a> to send email. </p>
2020

2121
<h3>Web API V3</h3>
22-
<p>Our V3 Web API provides functionality for <a href="{{root_url}}/API_Reference/Web_API_v3/Suppression_Management/index.html">managing user unsubscribes</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/Template_Engine/index.html">templating emails</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/IP_Management/index.html">managing IP addresses</a>, and <a href="{{root_url}}/API_Reference/Web_API_v3/Settings/enforced_tls.html">enforcing TLS</a>.</p>
22+
<p>Our V3 Web API provides functionality for <a href="{{root_url}}/API_Reference/Web_API_v3/Suppression_Management/index.html">managing user unsubscribes</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/Transactional_Templates/index.html">templating emails</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/IP_Management/index.html">managing IP addresses</a>, and <a href="{{root_url}}/API_Reference/Web_API_v3/Settings/enforced_tls.html">enforcing TLS</a>.</p>
2323

2424
<h3>Marketing Campaigns API</h3>
2525
<p>The SendGrid Marketing Email API provides developers with the ability to <a href="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html">manage marketing emails</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html">lists</a>, <a href="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/contactdb.html">identities</a>, and <a href="{{root_url}}/API_Reference/Web_API_v3/Marketing_Campaigns/campaigns.html">schedule delivery events</a></p>

source/Classroom/Basics/API/how_do_i_integrate_with_sendgrid.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ There are many&nbsp;different ways to use SendGrid’s email services so it all
1717

1818
- [SMTP](http://support.sendgrid.com/hc/en-us/articles/202821898-What-is-SMTP-)&nbsp;- 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-).&nbsp;
1919
- [Web API](https://sendgrid.com/docs/API_Reference/Web_API/index.html)&nbsp;- Send from your app using&nbsp; [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)&nbsp;- Send from our content creation UI and manage your lists via the website.&nbsp;
20+
- [Email Marketing App and API](https://sendgrid.com/docs/User_Guide/Legacy_Features/Marketing_Emails/index.html)&nbsp;- Send from our content creation UI and manage your lists via the website.&nbsp;
2121

2222
&nbsp;
2323

source/Classroom/Basics/API/what_are_the_sendgrid_apis_and_what_do_they_do.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ The SendGrid APIs allow you to interact with our system in a number of different
3131

3232
&nbsp;
3333

34-
**Marketing Email API** &nbsp;– 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&nbsp; [SendGrid Marketing Email API Documentation](http://sendgrid.com/docs/API_Reference/Marketing_Emails_API/index.html)&nbsp;page for more information or our&nbsp; [SendGrid Interactive Documentation](http://sendgrid.com/docs/api_workshop.html)&nbsp;for help building&nbsp;Marketing&nbsp;Email API calls.
34+
**Marketing Email API** &nbsp;– 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&nbsp; [SendGrid Marketing Email API Documentation](http://sendgrid.com/docs/API_Reference/Web_API/Legacy_Features/Marketing_Emails_API/index.html)&nbsp;page for more information or our&nbsp; [SendGrid Interactive Documentation](http://sendgrid.com/docs/api_workshop.html)&nbsp;for help building&nbsp;Marketing&nbsp;Email API calls.

0 commit comments

Comments
 (0)