Home platformOS Logo

Installing the Sendgrid Email Marketing Module

Last edit: Sep 25, 2020

This guide will help you install the platformOS Sendgrid Email Marketing Module.

Requirements

To follow the steps in this tutorial, you should have set up a platformOS Instance and your codebase. It helps if you know how to install a module, but we also describe the process specifically for the Sendgrid Email Marketing Module in this tutorial.

Additionally, you will need to have a Sendgrid account.

Steps

Installing the Sendgrid Email Marketing Module is a three-step process:

Step 1: Install Sendgrid Email Marketing Module

Log in to the Partner Portal and go to your Instance detail view.
In the Available modules section, search for "Sendgrid Email Marketing" and click Install. You will receive an Email Notification when the installation process is complete.

Step 2: Create a password

The Sendgrid Email Marketing Module is secure, so you will need to create a password to gain access to the admin pages.

To do this you will need to add the following GraphQL query, where <<PASSWORD>> is the value you want to use to gain access to the functionality:

mutation set_admin_pwd {
  constant_set(name: "admin_pwd", value: "<<PASSWORD>>") {
    name
    value
  }
}

Step 3: Connect to your Sendgrid account

You will need to have a Sendgrid account to use this module. If you do not already have an account, follow our tutorial about Adding Sendgrid to an Instance.

Add the following GraphQL query, where <<KEY HERE>> is the value for your Sendgrid API key, which can be found in your Sendgrid account on the API Keys page:

mutation set_sendgrid_key {
  constant_set(
    name: "sendgrid_api_key"
    value: "<<KEY HERE>>"
  ) {
    name
    value
  } 
}

The path for the campaigns functionality will be /admin/email_campaigns, for example, https://www.domain.com/admin/email_campaigns.

Next steps

Congratulations! You have installed the Sendgrid Email Marketing Module. Now you can begin sending emails straight from your Instance.

Contribute to this page

Github Icon

Questions?

We are always happy to help with any questions you may have.

contact us