Getting Started with Sendgrid

Disclaimer This is a portfolio sample. Please keep in mind that:

• The sole purpose of this page is to showcase my understanding and practice of API documentation.

• This content is not made from scratch. It is based on the publicely available official Sendgrid API documentation.

• I focused on demonstrating a practical and user-friendly workflow on a best-effort basis.

• This is content is intentionally incomplete and MUST NOT be used for production projects.

• If you need a comprehensive documentation, please check the available official Sendgrid API documentation.

Overview

There are several ways you can get started with the SendGrid API. The following instructions describe how to send your first email using cURL calls. This is one of many ways to send email with the SendGrid API - we also have implementations for the following libraries:

• PHP

• Python

• Node.js

• Java

• C#, Go

• Ruby

First Steps

Before you can start using the API, complete the following steps:

1. Create a SendGrid account.

2. Obtain your API Key.

Building Your API Call

Prerequisites

• Curl installed on your machine.

• Sender Authentication set up in your account.

• Active API key. Basic Authentication is no longer accepted.

A Sendgrid API call consists of a host, an authentication header, and a request. When building your API call remember that:

• The host for Web API v3 requests is always https://api.sendgrid.com/v3/.

• The Authorization header must include an API Key.

• Submit your payload to a resource using JSON format for POST and PUT requests.

• Total message size (message, headers, and attachments) must not exceed 20MB.

• Do not use IP addresses. Set your server host to https://api.sendgrid.com/v3/ instead to avoid unexpected interruptions due to a change in the SendGrid IPs.

Sending an Email Using the API

To send an email using the SendGrid API follow these steps:

1. Copy and paste the following curl code in a text editor:

curl --request POST \
--url https://api.sendgrid.com/v3/mail/send \
--header 'Authorization: Bearer <<YOUR_API_KEY>>' \
--header 'Content-Type: application/json' \
--data '{"personalizations":[{"to":[{"email":"[e-mail]","name":"John Doe"}],"subject":"Hello, World!"}],"content": [{"type": "text/plain", "value": "Heya!"}],"from":{"email":"[e-mail]","name":"Sam Smith"},"reply_to":{"email":"[e-mail]","name":"Sam Smith"}}'

1. Replace <<YOUR_API_KEY>> with your API key

2. In the --data parameter, add your specific information in the following keys:

   "to" "from" "reply_to" "name" "subject"

3. Copy the code and paste it in your terminal.

4. Hit Enter.

5. Check the inbox of the address you specified as the `"to" email address and see your message.