Skip to content

Commit 5df971a

Browse files
Merge pull request #7301 from segmentio/sendgrid-lists
[SendGrid Lists Destination] - doc for new SendGrid Lists Destination
2 parents 0d99e48 + 9014559 commit 5df971a

File tree

1 file changed

+85
-0
lines changed
  • src/connections/destinations/catalog/actions-sendgrid-audiences

1 file changed

+85
-0
lines changed
Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
title: SendGrid Lists (Actions) Destination
3+
engage: true
4+
id: 67338e95bf70aed334093dae
5+
hidden: true
6+
---
7+
8+
{% include content/plan-grid.md name="actions" %}
9+
10+
[SendGrid Lists (Actions)](https://mc.sendgrid.com/contacts/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} helps customers organize their email recipients into targeted groups, enabling them to send personalized, relevant content to specific audiences. This improves engagement, increases email deliverability, and streamlines campaign management.
11+
12+
This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:[email protected]).
13+
14+
## Getting started
15+
16+
SendGrid Lists (Actions) is designed to work with Engage Audiences only. The steps below outline how to create and connect the Destination to Engage and then to an Engage Audience. SendGrid Lists (Actions) is not designed to connect to Connections Sources.
17+
18+
### Create a SendGrid API Key
19+
1. Sign in to your SendGrid account, then navigate to **Settings** > **API Keys**.
20+
2. Click **Create API Key** and follow the instructions to generate a new API key. Be sure to grant the API key **Full Access** permission.
21+
3. Save the API key value in a secure location, as you will need it in later steps.
22+
23+
### Connect a SendGrid Lists (Actions) destination to an Engage Space
24+
25+
1. From your Segment workspace's home page, navigate to **Engage** > **Engage Settings** > **Settings** and click **Add destination**.
26+
2. Search for SendGrid Lists (Actions) and select the SendGrid Lists (Action) tile. Click **Add Destination** and **Confirm Source**.
27+
3. On the Basic Settings screen, provide **Name** and **API Key** values in the specified fields, toggle "Enable destination" to on, and then click **Save Changes**.
28+
29+
### Create a Mapping
30+
31+
1. From your Segment workspace's home page, click **Connections** > **Destinations** and select the SendGrid Lists (Actions) destination you previously created.
32+
2. Click on **Mappings** > **New Mapping** > **Sync Audience** > **Save**.
33+
3. On the next screen, enable the Mapping using the **Status** toggle.
34+
35+
### Connect an Audience
36+
37+
1. From your Segment workspace's home page, navigate to **Engage** > **Audiences** and select the Audience you'd like to sync to SendGrid.
38+
2. Click **Add Destination**, and select the SendGrid Lists (Actions) destination you previously created.
39+
3. Enter a **List Name**, select **Default Setup**, and click **Save**. When prompted, select **Add 1 Destination**.
40+
41+
The SendGrid Lists (Actions) destination will now start to sync your Engage Audience to a SendGrid List.
42+
43+
{% include components/actions-fields.html %}
44+
45+
46+
## Troubleshooting
47+
48+
### Does Segment create Lists in SendGrid?
49+
Segment automatically creates Lists in SendGrid. If you provide a value in the **Name** field, Segment names the List the value you provided. If you do not provide a name in the **Name** field, Segment gives the List the Engage Audience's **Audience Key** value.
50+
51+
### Does Segment create new Contacts in SendGrid?
52+
Segment creates Contacts in SendGrid if a Contact doesn't already exist for the user.
53+
54+
### Does Segment delete Contacts from SendGrid?
55+
Segment doesn't delete Contacts from SendGrid. If you remove a user from an Engage Audience, Segment does remove the Contact from the associated SendGrid List, but doesn't delete the Contact from SendGrid.
56+
57+
## Best practices
58+
59+
### Sending additional user traits
60+
Segment supports sending Engage user profile traits to SendGrid Contact User Attributes. The following additional manual configuration steps are required:
61+
62+
1. Use [Trait Enrichment](/docs/engage/trait-activation/trait-enrichment/) to include specific user profile traits when syncing users to a SendGrid List.
63+
2. Standard User Attributes: Use the [Sync Audience Action](#sync-audience-action)'s User Attributes field to map the following [Contact Profile Fields](https://www.twilio.com/docs/sendgrid/ui/managing-contacts/segmenting-your-contacts#contact-profile-fields){:target="_blank”} to SendGrid:
64+
- First Name
65+
- Last Name
66+
- Phone Number (must be in [E.164](https://www.twilio.com/docs/glossary/what-e164){:target="_blank”} format)
67+
- Address Line 1
68+
- Address Line 2
69+
- City
70+
- State/Province/Region
71+
- Country
72+
- Postal Code
73+
3. Custom User Attributes: Define a custom User Attribute in SendGrid, then use [Sync Audience ](#sync-audience-action) Action to send custom User Attributes to SendGrid using the Custom Fields field. You can only send string, number, and date values to SendGrid with this method.
74+
75+
### Supported identifiers
76+
At least one of the following identifier types is required when syncing members of an Engage Audience to a SendGrid List:
77+
- Email Address (must be a valid email address)
78+
- Anonymous ID
79+
- Phone Number ID (must be in [E.164](https://www.twilio.com/docs/glossary/what-e164){:target="_blank”} format)
80+
- External ID
81+
82+
To sync Engage users to a list using Anonymous ID, Phone Number ID, and External ID identifier types, complete the following configuration steps:
83+
84+
1. Configure [ID Sync](/docs/engage/trait-activation/id-sync/) to include Anonymous ID, Phone Number ID, or External ID identifiers when syncing users from an Engage Audience to the SendGrid List.
85+
2. Map the Anonymous ID, Phone Number ID, and External ID identifiers using the [Sync Audience ](#sync-audience-action) Action's Anonymous ID, Phone Number ID, and External ID fields.

0 commit comments

Comments
 (0)