This article describes how to set up the SendGrid connector.

Table of Contents Placeholder

Connector Actions

Action Name AudienceStream EventStream
Add Recipient to List
Remove Recipient from List
Upsert Recipient
Remove Recipient
Send Transactional Template Email

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

After adding the connector, configure the following settings:

  • API Key
    • API Key for SendGrid Connector to use.
    • This Connector requires the following Marketing Campaigns for the API Key:
      • 'Full Access'
      • Mail Send 'Full Access'
      • Template Engine 'Read Access'
    • For more information on SendGrid API Key, see SendGrid API Keys.

Action Settings - Parameters and Options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - Add Recipient to List


Parameter Description
SendGrid List
  • SendGrid list to add recipient to
Recipient ID to Add
  • ID of recipient to add to SendGrid list

Action - Remove Recipient from List


Parameter Description
SendGrid List
  • SendGrid list to remove recipient from
Recipient ID to Remove
  • ID of Recipient to remove from SendGrid list

Action - Upsert Recipient


Parameter Description
  • Map upsert recipient attributes 

Action - Remove Recipient


Parameter Description
Recipient Key
  • ID of Recipient to remove

Action - Send Transactional Template Email


Parameter Description
  • Recipient email to send email to
  • The sender of this email
Email Template
  • Please choose from this list of Email Templates, which must contain at least 1 active version, to use for email.
  • When choosing a custom value, please specify a template ID.
Email Body Content Type
  • Optional.
  • Default value is "html".
  • Select either a static value or set an attribute with the value of "html" for html email content or "text" for plain text email content.
Template Substitutions
  • Specify substitutions for the selected Email Template.
  • See Web API v2 Mail Send for more information on API call details for this action.
  • See Substitutions and Sections for more information on template substitutions.
  • Example: If your email template is the following
    "Hello there :name!, mapping the value World! to the key :name displays as "Hello there World!" in the email sent.