API
SendGrid has multiple APIs that allow you to customize the service and retrieve information as needed. Below we briefly explain each API and their purpose.
Send Email
There are three different technical concepts you should know about SendGrid related to sending email:
SMTP
This is a protocol rather than an API. SMTP is widely supported by applications and is usually the fastest way to integrate with SendGrid. Learn how to integrate using SMTP.
Web Email API
If SMTP is not used, we also offer a simple Web API to send email.
SMTPAPI
This is an API that allows you to tag your emails to get detailed statistics on each tag, send multiple customized emails in one request via mail merge, and configure each app on a per email basis. This is done by passing a JSON string in the X-SMTPAPI header if using SMTP or in the x-smtpapi HTTP parameter if using the web API. Using the SMTP API
Configure Service or Retrieve Information
SendGrid has a Web API that allows customers to retrieve information about their account such as statistics, bounces, spam reports, unsubscribes, and other information. In addition, the Web API allows customers to create sub-accounts and control the settings of these accounts for an OEM setup. See the list of Web API calls.
Receive Email
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 Parse API. Application examples include:
- Posting blog articles via email
- Processing email replies in a mailing list
- Allowing users to upload pictures to their profile via email
- Submit support requests via email
Real-time Event Notification
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 Event API. Examples of applications include:
- Associate a spam report with a specific campaign and user in your application
- Know real-time when a user has clicked on a confirmation email
- Get the specific link clicked on an email
- Get the browser version used by a customer
- Know the specific MTA response for a customer
SendGrid has multiple APIs that allow you to customize the service and retrieve information as needed. Below we briefly explain each API and their purpose.
Send Email
There are three different technical concepts you should know about SendGrid related to sending email:
SMTP
This is a protocol rather than an API. SMTP is widely supported by applications and usually the fastest way to integrate with SendGrid. For more information on how to integrate it click here.
REST Email API
If SMTP is not used, we also offer a simple REST API to send email. For information click here.
SMTPAPI
This is an API that allows you to tag your emails to get detail statistics on each tag, send multiple customized emails in one request via mail merge, and configure each app on a
per email basis. This is done by passing a JSON string in the X-SMTPAPI header if using SMTP or in the x-smtpapi HTTP parameter if using the REST Email API. For information click here.
Configure Service or Retrieve Information
SendGrid has a Web API that allows customers to retrieve information about their account such as statistics, bounces, spam reports, unsubscribes, and other information. In addition, the Web API
allows customers to create sub-accounts and control the settings of these accounts for an OEM setup. For a list of Web API calls go here. The following lists the capabilities of the Web API.
Profile
Retrieve and update your profile information such as credentials and email address.
Bounces
Retrieve and delete your email bounces.
Subscription Management
Add, retrieve, and delete unsubscribed emails.
Spam Reports
Retrieve and delete your spam reports.
Invalid Emails
Retrieve and delete your invalid emails.
Statistics
View a detailed snapshot of how you have been using SendGrid
Event Notification URL
Allow you to to manage your event notification URL
Reseller
Manage your subusers
Parse
Manage your parse settings
Filter / App
Note that Apps now replace Filters
