Skip to main content
Skip table of contents

Email service provider: SendGrid

Account configuration

This section describes how to set up a SendGrid account to configure an RPI SendGrid email channel.

Setting up an Account

  1. To acquire a SendGrid account, you will need to sign up for either a free or a paid account.

  2. At the SendGrid home page, hover over the Pricing tab and select Start for Free.

  3. A SendGrid sign up form will be displayed. Fill in the required details.

  4. Select Create Account.

  5. Once you have created your account successfully, you will be emailed by SendGrid support to activate your account, and may log into the SendGrid portal.

The table below describes the SendGrid RESTful service-based API calls utilized by the RPI SendGrid channel plugin.

API

HTTP VERB

Data

Usage

https://sendgrid.com/api/mail.send.json

POST

api_user=your_sendgrid_ username&api_key=your_ sendgrid_password&to=d estination@example.com &toname=Destination&su bject=Example_Subject&t ext=testingtextbody&from=info@domain.com

This endpoint allows you to send email.

https://sendgrid.com/api/profile.get.json

POST

api_user=your_sendgrid_ username&api_key=your_ sendgrid_password

View your SendGrid Profile.

https://sendgrid.com/api/unsubscribes.delete.json

POST

api_user=your_sendgrid_ username&api_key=your_ sendgrid_password&email =emailToDelete@domain.com

Delete entries in the Unsubscribes list.

https://sendgrid.com/api/unsubscribes.get.json

POST

api_user=your_sendgrid_ username&api_key=your_ sendgrid_password&date=1

Retrieve entries in the Unsubscribes list.

Details about SendGrid APIs.

Setting up an API key for SendGrid Web API v3

An API key and API key ID are required to configure a SendGrid email channel to use the SendGrid Web API v3.

  1. In a browser, sign in to SendGrid.

  2. Select Settings>API Keys.

  3. In the API Keys section, select Create API Key.

  4. Select General API Key.

  5. Enter the name of the API Key, select API Key Permission.

  6. Select Save.

  7. Copy the API Key and store it in a safe place to avoid your account being compromised.

A SendGrid account must have the following minimum required permissions when used with RPI:

  • API Keys - Read Access

  • Mail Send - Full Access

  • Category - Full Access

  • Email Activity - Read Access

  • Suppressions - Full Access

  • Tracking - Full Access

Additional resources

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.