---
title: SendGrid
slug: docs/sendgrid
docTags:
createdAt: 2024-02-28T14:32:00.972Z
---
# Using Sendgrid email API
## Introduction
This section explains how you can integrate SendGrid with a Cloud Code function. After completing this guide with step-by-step instructions, you will be ready to use your function in your App and call it at your iOS or Android App.
## Prerequisites
:::hint{type="info"}
To complete this tutorial, you will need:
- An app created at Back4App.
- Follow the [Create New App tutorial](https://www.back4app.com/docs/get-started/new-parse-app) to learn how to create an app at Back4App.
- Back4App Command Line Configured with the project.
- Follow the [Setting up Cloud Code tutorial](https://www.back4app.com/docs/local-development/parse-cli) to learn how to set up cloud code for a project.
- Account created in [Twilio](https://login.twilio.com/u/signup?state=hKFo2SBSTHoyUXZ1NnUzTjZaMHk2Q3EtaXV5LUtnUlhaMzdtN6Fur3VuaXZlcnNhbC1sb2dpbqN0aWTZIE9JTzFKSU9LaVMzTV9fYVo0VDM0a2pnSEpZM09SYUo4o2NpZNkgTW05M1lTTDVSclpmNzdobUlKZFI3QktZYjZPOXV1cks).
:::
## Let’s get started!
We will write a function using SendGrid that you will be able to work with a lot from possibilities as Delivering messages to our customers and configuring parameters to use the SendGrid v3 REST API.
To learn how to create or access an Account in SendGrid, check the links given below:
[Create a new account](https://signup.sendgrid.com/) - [Log in to your account](https://app.sendgrid.com/login)
## 1 - Create a SendGrid API Key
The most important step before start to code is create the correct keys to setup your environment. After accessing your account, locate in the Settings drop-down menu, the `API Keys` option as in the picture below:
::Image[]{src="https://api.archbee.com/api/optimize/yD3zCY-NNBBIfd0uqcfR5/S5lS0LacIcaC-xBz3Krya_image.png" size="30" width="162" height="207" position="center" showCaption="false"}
After that, at the top right locate and choose an identification to the`API Key Name`, like as shown below:
:::hint{type="info"}
As you can see at the image above, it’s necessary to select one option to allow the *Full Access *to the API Key.
:::
After click on the `Create & View` to proceed with creating of the key, you will be able to see the screen below:
:::hint{type="warning"}
**Hint**: Be careful to write it down, as there is no way to retrieve it. Click on the text to copy it.
:::
## 2 - Add a function to the Cloud Code
The main strategy to this way of using SendGrid’s API is to create a function on the Cloud Code named `sendgridEmail` and call it from the App.
### 2.1 - Install module from Sendgrid
Create a file called `package.json`, and inside this file, you need to install the Twilio module, like:
```json
1 {
2 "dependencies": {
3 "@sendgrid/mail": "*"
4 }
5 }
```
### 2.2 - Implement Cloud Code
You should note that every email field has to be send by the App – from the subject to the content – as a parameters. The code is as follows:
:::CodeblockTabs
Parse Server 3.X
```javascript
1 Parse.Cloud.define("sendgridEmail", async(request) => {
2 const sgMail = require('@sendgrid/mail');
3
4 // Import SendGrid module and call with your SendGrid API Key
5 sgMail.setApiKey("your SendGrid API key here");
6
7 const msg = {
8 to: request.params.toEmail,
9 replyTo: 'info@youremail.com',
10 from: 'info@youremail.com',
11 subject: request.params.subject,
12 text: request.params.body
13 };
14
15 try{
16 await sgMail.send(msg);
17 return 'OK'
18 } catch (e){
19 return `Error: ${e.message}`
20 }
21
22 });
```
Parse Server 2.X
```javascript
1 Parse.Cloud.define("sendgridEmail", (request, response) => {
2 const sgMail = require('@sendgrid/mail');
3
4 // Import SendGrid module and call with your SendGrid API Key
5 sgMail.setApiKey("your SendGrid API key here");
6
7 const msg = {
8 to: request.params.toEmail,
9 replyTo: 'info@youremail.com',
10 from: 'info@youremail.com',
11 subject: request.params.subject,
12 text: request.params.body
13 };
14
15 sgMail.send(msg).then(() => {
16 response.success("The message was sent!");
17 })
18 .catch(error => {
19 //Log friendly error
20 response.error(error.toString());
21 });
22 });
```
:::
:::hint{type="warning"}
**Hint**: Remember to change the fields `from` and `reply_to` to your personal information.
:::
Then it is necessary to implement a call to the Cloud Code function on the app.
## 3 - Call Cloud Code function
In this current step, we can work with two possibilities to call our function, they’re: Android and iOS (Swift and Objective-C).
:::CodeblockTabs
Android
```java
1 Map params = new HashMap<>();
2
3 // Create the fields "emailAddress", "emailSubject" and "emailBody"
4 // As Strings and use this piece of code to add it to the request
5 params.put("toEmail", emailAddress);
6 params.put("subject", emailSubject);
7 params.put("body", emailBody);
8
9 ParseCloud.callFunctionInBackground("sendgridEmail", params, new FunctionCallback