forked from sendgrid/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
89 lines (69 loc) · 6.34 KB
/
index.html
File metadata and controls
89 lines (69 loc) · 6.34 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
---
layout: page
weight: 100
title: API Reference Index
seo:
description: You can use SendGrid via SMTP or our simple to use Web API. Understand how best to utilize SendGrid.
title: Email API Reference
navigation:
show: true
---
{% anchor h2 %}
The v3 API
{% endanchor %}
<p>Our RESTful V3 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>
{% anchor h2 %}
Send Email
{% endanchor %}
<h3>Mail Send v3</h3>
You can send email by using the mail send endpoint in our Web API v3. For more information on how to begin sending email using this endpoint, please visit the <a href="{{root_url}}/API_Reference/Web_API_v3/Mail/index.html">v3 Mail Send Overview</a>.
<p>
<h3>Mail Send v2</h3>
<p>You can also still use our <a href="{{root_url}}/API_Reference/Web_API/mail.html">Web API v2 mail send endpoint</a> to send email.</p>
<h3>Marketing Campaigns API</h3>
<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>
<h3>SMTP</h3>
<p>This is a protocol rather than an API. SMTP is widely supported by applications and is usually the fastest way to integrate with SendGrid. <a href="{{root_url}}/Integrate/index.html">Learn how to integrate using SMTP</a>.</p>
<h3>SMTPAPI</h3>
<p>When sending with SMTP, the <a href="{{root_url}}/API_Reference/SMTP_API/index.html">SMTP API</a> allows you to add specific instructions to your SMTP emails, that match the functionality of our mail endpoint. You can add custom arguments, track your emails engagement, and send multiple emails with the same request. <a href="{{root_url}}/API_Reference/SMTP_API/index.html">Using the SMTP API</a></p>
{% anchor h2 %}
Receive Email
{% endanchor %}
<p>SendGrid can parse the email bodies and attachments from incoming emails and post them to your web application. For details on how to integrate your application to start receiving emails please refer to our <a href="{{root_url}}/API_Reference/Webhooks/parse.html">Parse Webhook</a>. Application examples include:</p>
<ul>
<li>Posting blog articles via email</li>
<li>Processing email replies in a mailing list</li>
<li>Allowing users to upload pictures to their profile via email</li>
<li>Submit support requests via email</li>
</ul>
{% anchor h2 %}
Real-time Event Notification Webhook
{% endanchor %}
<p>SendGrid can send real-time notifications about events that happen on the SendGrid system to a URL. These events include clicks, opens, unsubscribe, bounces, and many others. These events include more data than what SendGrid records and allow customers to customize their own reporting. What makes this API even more powerful is the ability to include user-defined parameters in each event. Through our SMTP API, customers can embed unique parameters in each email they send. These parameters are then passed to each event notification so your application can associate these events with your customers. Read more about the <a href="{{root_url}}/API_Reference/Webhooks/event.html">Event Webhook</a>. Examples of applications include:</p>
<ul>
<li>Associate a spam report with a specific campaign and user in your application</li>
<li>Know real-time when a user has clicked on a confirmation email</li>
<li>Get the specific link clicked on an email</li>
<li>Get the browser version used by a customer</li>
<li>Know the specific MTA response for a customer</li>
</ul>
{% anchor h2 %}
Configure Your SendGrid Account
{% endanchor %}
<p>The Web API allows customers to create sub-accounts and control the settings of these accounts for an OEM setup. See the <a href="{{root_url}}/API_Reference/Web_API/index.html">list of Web API calls</a></p>
<p>You can configure your account settings such as updating your <a href="{{root_url}}/API_Reference/Web_API/profile.html">profile information</a>. You can also <a href="{{root_url}}/API_Reference/Web_API/filter_commands.html">setup SendGrid Apps</a>, <a href="{{root_url}}/API_Reference/Web_API/filter_settings.html">configure Apps</a>, and configure <a href="{{root_url}}/API_Reference/Web_API/parse_settings.html">Parse Webhook settings</a>.</p>
<p>
With <a href="{{root_url}}/User_Guide/Settings/teammates.html">Teammates</a>, you can add multiple users to the same SendGrid account. Teammates gives you the ability to create and manage many different account users, each with their own specific set of permissions and levels of access. To learn more about Teammates, visit our <a href="{{root_url}}/User_Guide/Settings/teammates.html">User Guide</a> or our <a href="{{root_url}}/API_Reference/Web_API_v3/teammates.html">API Reference</a>.
</p>
{% anchor h2 %}
Retrieve Information
{% endanchor %}
<p>SendGrid has a Web API that allows customers to retrieve information about their account such as statistics, bounces, spam reports, unsubscribes, and other information.</p>
<p>You can fetch information via our api endpoints for <a href="{{root_url}}/API_Reference/Web_API/blocks.html">Blocks</a>, <a href="{{root_url}}/API_Reference/Web_API/bounces.html">Bounces</a>, <a href="{{root_url}}/API_Reference/Web_API/invalid_emails.html">Invalid Emails</a>, <a href="{{root_url}}/API_Reference/Web_API/spam_reports.html">Spam Reports</a>, <a href="{{root_url}}/API_Reference/Web_API/unsubscribes.html">Unsubscribes</a>, and <a href="{{root_url}}/API_Reference/Web_API/Statistics/index.html">Statistics</a>.</p>
{% anchor h2 %}
Reseller APIs
{% endanchor %}
<ul>
<li><a href="">Reseller API</a> - Allows SendGrid Reseller Customers to manage every aspect of their customer's SendGrid accounts.</li>
<li><a href="">Reseller Haiku API</a> - Allows SendGrid Reseller Customers to manage servers and accounts through SendGrid.</li>
</ul>