Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
0486056
Create CAN-SPAM
leormanelis Jan 19, 2015
d84d813
Replaced markdown with HTML tags for bolded items
eschallock Oct 30, 2015
959efea
Merge branch 'develop' into eschallock-patch-2
eschallock Nov 4, 2015
6400dc0
Merge branch 'patch-27' of https://github.com/leormanelis/docs into l…
eschallock Nov 4, 2015
c8a5f79
Edited CAN-SPAM Glossary Entry
eschallock Nov 4, 2015
493bb87
Merge branch 'leormanelis-patch-27' into develop
eschallock Nov 4, 2015
f3baa5a
Merge pull request #1359 from sendgrid/eschallock-patch-2
eschallock Nov 5, 2015
99ca126
paragraphs and bold tags
Nov 5, 2015
d78b325
FLN-1587 Campaigns API update/send unsubscribe validation
ehudc Nov 5, 2015
79dd537
Advanced Suppression Manager changed to Unsubscribe Groups
eschallock Nov 6, 2015
de7c6fd
removed Advanced Suppression Manager from link to Global Suppressions…
eschallock Nov 6, 2015
f6dd82b
removed ASM from link to Group Suppressions API
eschallock Nov 6, 2015
6a9eede
Changed ASM to Unsubscribe Group(s)
eschallock Nov 6, 2015
799a163
Merge pull request #1374 from sendgrid/mbernier-patch-2
Nov 6, 2015
1e9d1ec
Merge pull request #1375 from sendgrid/FLN-1587
Nov 6, 2015
5d26bf0
Merge pull request #1376 from sendgrid/eschallock-patch-1
Nov 6, 2015
588ec01
Merge pull request #1377 from sendgrid/eschallock-patch-2
Nov 6, 2015
fef13bb
Merge pull request #1378 from sendgrid/eschallock-patch-3
Nov 6, 2015
659e55e
Merge pull request #1379 from sendgrid/eschallock-patch-4
Nov 6, 2015
da5eece
replaced ASM group with Unsubscribe Group
eschallock Nov 6, 2015
1f45231
changed ASM to Unsubscribe Groups
eschallock Nov 6, 2015
38810de
changed ASM to Unsubscribe Group
eschallock Nov 6, 2015
9c31794
fixed unsubscribe group typo
eschallock Nov 6, 2015
d350dce
changed ASM to Unsubscribe Group
eschallock Nov 6, 2015
5f01a84
changed ASM to Unsubscribe Groups
eschallock Nov 6, 2015
4d57dca
Merge pull request #1381 from sendgrid/eschallock-patch-1
eschallock Nov 6, 2015
b860128
Merge pull request #1382 from sendgrid/eschallock-patch-2
eschallock Nov 6, 2015
2f4bc0c
Merge pull request #1383 from sendgrid/eschallock-patch-3
eschallock Nov 6, 2015
23e5536
Merge pull request #1384 from sendgrid/eschallock-patch-4
eschallock Nov 6, 2015
6d73562
Merge pull request #1385 from sendgrid/eschallock-patch-5
eschallock Nov 6, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/API_Reference/SMTP_API/suppressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ navigation:
---

{% anchor h2 %}
Defining an ASM Group When Sending
Defining an Unsubscribe Group When Sending
{% endanchor %}

To specify a group when sending an email, add the group's ID to the X-SMTPAPI header of an SMTP message, or in the x-smtpapi parameter of a [mail.send API
Expand All @@ -24,7 +24,7 @@ You may only specify one group per send, and you should wait one minute after cr
{% endcodeblock %}

{% anchor h2 %}
Defining ASM Groups to display on the Manage Preferences page
Defining Unsubscribe Groups to display on the Manage Preferences page
{% endanchor %}

To specify which groups to display on the Manage Preferences page of an email, add the group IDs to the X-SMTPAPI header of an SMTP message, or in the x-smtpapi parameter of a [mail.send API
Expand All @@ -45,8 +45,8 @@ You can specify up to 25 groups to display.
Groups
{% endanchor %}

You can find your group IDs by looking at the Group ID column in the Advanced Suppression Manager UI, or by calling the [GET method]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/groups.html#-GET) of the groups resource.
You can find your group IDs by looking at the Group ID column in the Unsubscribe Groups UI, or by calling the [GET method]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/groups.html#-GET) of the groups resource.

Related Articles:

* You can create ASM groups via the [API V3 > ASM Endpoint]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html#-POST).
* You can create Unsubscribe groups via the [API V3 > Unsubscribe Groups Endpoint]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html#-POST).
4 changes: 2 additions & 2 deletions source/API_Reference/Web_API/filter_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ All fields except version are required for each call.
{% parameter 'group_unsubscribe' 'Yes' 'Notify when recipient unsubscribes from group' '1' %}
{% parameter 'group_resubscribe' 'Yes' 'Notify when recipient resubscribes to group' '1' %}
{% parameter 'spamreport' 'Yes' 'Notify when email is marked as spam' '1' %}
{% parameter 'group_unsubscribe' 'Yes' 'Notify when email unsubscribes from an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
{% parameter 'group_resubscribe' 'Yes' 'Notify when email resubscribes to an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
{% parameter 'group_unsubscribe' 'Yes' 'Notify when email unsubscribes from an [Unsubscribe Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
{% parameter 'group_resubscribe' 'Yes' 'Notify when email resubscribes to an [Unsubscribe Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
{% parameter 'url' 'Yes' 'The post notification url to post these event messages to' 'https://notificationurl.example.com/event' %}
{% parameter 'version' 'No' 'The version of the Event API you wish to use. (1-3)' '3' %}
{% endparameters %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,11 @@ In order to send or schedule the campaign, you will be required to provide a sub
"list_ids": "list_ids do not all exist"
"segment_ids": "segment_ids do not all exist"
"suppression_group_id": "suppression_group_id does not exist"
"unsubscribes": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
"": "The JSON you have submitted cannot be parsed."
"": "You've reached your limit of 250 campaigns. Please delete one or more and try again."

## Campaigns [/campaigns{?limit,offset}]
## Campaigns [/campaigns?limit={limit}&offset={offset}]

### Get all Campaigns [GET]
Returns campaigns in reverse order they were created (newest first)
Expand Down Expand Up @@ -211,6 +212,7 @@ Returns an empty array if no campaigns exist
"list_ids": "list_ids do not all exist"
"segment_ids": "segment_ids do not all exist"
"suppression_group_id": "suppression_group_id does not exist"
"unsubscribes": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
"": "The JSON you have submitted cannot be parsed."

+ Response 403
Expand Down Expand Up @@ -249,7 +251,9 @@ Returns an empty array if no campaigns exist
"sender_id": "sender_id can't be blank"
"plain_content": "plain_content can't be blank, please provide plain text or html content"
"list_ids": "You must select at least 1 segment or 1 list to send to."
"":"You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
"unsubscribe_tag": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
"suppression_group_id": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
"": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"

+ Response 403

Expand Down Expand Up @@ -304,6 +308,8 @@ Returns an empty array if no campaigns exist
"plain_content": "plain_content can't be blank, please provide plain text or html content"
"list_ids": "You must select at least 1 segment or 1 list to send to."
"send_at": "Please choose a future time for sending your campaign."
"unsubscribe_tag": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
"suppression_group_id": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
"": "The JSON you have submitted cannot be parsed."
"":"You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"

Expand Down Expand Up @@ -406,6 +412,8 @@ If the specified campaign is in the process of being sent, the only option is to

### Send a Test Campaign [POST]

To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]

+ Request (application/json)

+ Body
Expand Down
4 changes: 2 additions & 2 deletions source/API_Reference/Webhooks/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,10 +305,10 @@ The resulting webhook call
*Note: The event and the email are not overwritten, because "event" and "email" are reserved and SendGrid defaults to the reserved key for webhooks.*

{% anchor h2 %}
Advanced Suppression Manager
Unsubscribe Groups
{% endanchor %}

If [ASM groups]({{root_url}}/User_Guide/Suppressions/advanced_suppression_manager.html) are used over the SMTP API they will be returned by the Event Webhook as such:
If [Unsubscribe Groups]({{root_url}}/User_Guide/Suppressions/advanced_suppression_manager.html) are used over the SMTP API they will be returned by the Event Webhook as such:

{% codeblock lang:json %}
{
Expand Down
4 changes: 2 additions & 2 deletions source/Classroom/Deliver/suppressions_vs_unsubscribes.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ navigation:
---

{% info %}
If you are not using ASM, it is the default functionality to unsubscribe a user at the global level when they click unsubscribe links
If you are not using suppression management with Unsubscribe Groups, it is the default functionality to unsubscribe a user at the global level when they click unsubscribe links.
{% endinfo %}

When using ASM, a recipient clicking an unsubscribe link can choose which groups to unsubscribe from, called a "group unsubscribe", or may choose to opt out of all emails, called a "global unsubscribe".
When using Unsubscribe Groups, a recipient clicking an unsubscribe link can choose which groups to unsubscribe from, called a "group unsubscribe", or may choose to opt out of all emails, called a "global unsubscribe".

You can manage your global unsubscribes via [Email Reports > Unsubscribes]({{site.app_url}}/suppressions/global_unsubscribes) in the SendGrid portal.

Expand Down
27 changes: 27 additions & 0 deletions source/Glossary/CAN-SPAM
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
layout: page
weight: 0
title: CAN-SPAM
navigation:
show: true
seo:
title: CAN-SPAM
override: true
description: The CAN-SPAM Act lists the guidelines, requirements, and penalties regarding the sending of commercial bulk email.
---

The [CAN-SPAM Act of 2003](https://www.ftc.gov/tips-advice/business-center/guidance/can-spam-act-compliance-guide-business) lists the guidelines, requirements, and potential penalties for noncompliance regarding the commercial use of email and the legal rights of recipients of commercial email. CAN-SPAM provides several requirements for commercial senders including, but not limited to:

- Senders may not use false or misleading headers.
- Senders may not use deceptive subject lines.
- Senders must give their recipients the option of opting out of commercial email.
- Senders must honor all opt-out requests.

This is by no means a complete description of CAN-SPAM, please visit the [CAN-SPAM Act Compliance Guide](https://www.ftc.gov/tips-advice/business-center/guidance/can-spam-act-compliance-guide-business) for more information.

{% warning %}
CAN-SPAM is not limited to bulk email. Any commercial email communication, including business-to-business and business-to-customer email, is covered by the CAN-SPAM Act.
{% endwarning %}

Related Articles:
- [SendGrid Deliverability Tips and Tricks]({{root_url}}/Classroom/Deliver/index.html)
2 changes: 1 addition & 1 deletion source/Integrate/libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Java
- [smtpapi-java](http://github.com/sendgrid/smtpapi-java) *by SendGrid*- Official Java library to create SMTP API headers
- [sendgrid-google-java](https://github.com/sendgrid/sendgrid-google-java) *by SendGrid* - Java library for use with Google App Engine
- [sendgrid4j](https://github.com/shunjikonishi/sendgrid4j) *by Shunji Konishi* - Simple SendGrid client for Java
- [sendgrid-asm-java](https://github.com/krenfro/sendgrid-asm-java) *by Kyle Renfro* - Advanced Suppression Manager (ASM) Java Client
- [sendgrid-asm-java](https://github.com/krenfro/sendgrid-asm-java) *by Kyle Renfro* - Unsubscribe Groups Java Client

{% anchor h3 %}
JavaScript
Expand Down
31 changes: 20 additions & 11 deletions source/User_Guide/Marketing_Campaigns/Campaigns/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,31 +46,40 @@

From here you can change the content in your email without affecting your template, meaning that any changes here will be saved for this campaign only and will not change your template. This allows you to use the same template multiple times without having to worry about changes from campaign to campaign. As you make changes to your campaign, you will notice the “Save” button change to “Saving…” as the editor autosaves your changes.

**Campaign Name:** This is the name of your campaign, so you can find it again from the campaigns page. Newly created campaigns are named "Untitled" unless you specify a name. You are not required to give your campaign a unique name.
<strong>Campaign Name:</strong> This is the name of your campaign, so you can find it again from the campaigns page. Newly created campaigns are named "Untitled" unless you specify a name. You are not required to give your campaign a unique name.

{% warning %}
Your <a href="{{root_url}}/User_Guide/Marketing_Campaigns/senders.html">sender identity</a> must be verified before you use it to send a campaign.
{% endwarning %}
<p>
<strong>From Sender:</strong> This is the person from whom this email will be sent. The user will see this name as the sender on their email.
</p>

**From Sender:** This is the person from whom this email will be sent. The user will see this name as the sender on their email.
<p>
<strong>Email Subject:</strong> The subject line the user will see. Note: You can use substitution tags in order to personalize the email subject for your customers.
</p>

**Email Subject:** The subject line the user will see. Note: You can use substitution tags in order to personalize the email subject for your customers.

**Lists/Segments to Send To:** You can choose which contacts will receive your email. You can choose more than one list or segment. A contact in multiple selected lists will only receive the email once.
<p>
<strong>Lists/Segments to Send To:</strong> You can choose which contacts will receive your email. You can choose more than one list or segment. A contact in multiple selected lists will only receive the email once.
</p>

{% warning %}
When you schedule a campaign, the sender identity used will not be able to be deleted.
{% endwarning %}

**Send Immediately / Schedule:** You can set when this email will be sent to your contacts. “Send Immediately” is selected by default. If you would like to schedule your campaign, click the “On” button to toggle the custom schedule options. Scheduled campaigns will be scheduled only after you click "Schedule" in the upper right hand corner. Remember, your timezone is set in your <a href="https://sendgrid.com/docs/User_Guide/Settings/account.html">account settings</a>.

**Categories:** This is a category that you can set for your emails, which will help you track delivery metrics in the SendGrid advanced statistics section based on your own classifications of the emails you are sending. To add a category, type the name and press enter.
<p>
<strong>Send Immediately/Schedule:</strong> You can set when this email will be sent to your contacts. “Send Immediately” is selected by default. If you would like to schedule your campaign, click the “On” button to toggle the custom schedule options. Scheduled campaigns will be scheduled only after you click "Schedule" in the upper right hand corner. Remember, your timezone is set in your <a href="https://sendgrid.com/docs/User_Guide/Settings/account.html">account settings</a>.
</p>
<p>
<strong>Categories:</strong> This is a category that you can set for your emails, which will help you track delivery metrics in the SendGrid advanced statistics section based on your own classifications of the emails you are sending. To add a category, type the name and press enter.
</p>

{% info %}
You can create up to 10 different categories.
{% endinfo %}

**Unsubscribe Group:** This allows you to set the group that applies to this email, so that users who have already opted out of emails do not receive them again. In order to keep your sender rating high, it is important to make sure you don’t send emails to users who have unsubscribed in the past. In order to create a new suppression group, please go to the <a href="https://app.sendgrid.com/suppressions/advanced_suppression_manager">Unsubscribe Groups</a> page to add a new suppression group. Please see our <a href="{{root_url}}/User_Guide/Suppressions/index.html">Suppressions docs</a> for more information.
<p>
<strong>Unsubscribe Group:</strong> This allows you to set the group that applies to this email, so that users who have already opted out of emails do not receive them again. In order to keep your sender rating high, it is important to make sure you don’t send emails to users who have unsubscribed in the past. In order to create a new suppression group, please go to the<a href="https://app.sendgrid.com/suppressions/advanced_suppression_manager">Unsubscribe Groups</a> page to add a new suppression group. Please see our <a href="{{root_url}}/User_Guide/Suppressions/index.html">Suppressions docs</a> for more information.
</p>

{% warning %}
The test send will be deducted from your email package limit.
Expand All @@ -80,7 +89,7 @@
This test email will not replace your substitution tags, as you will be sending to an email address and not to a formal contact in your database.
{% endinfo %}

**Send Test Email** - If you want to see the email as your customer would see it, you can enter your email address here and click “Send.” The campaign will be sent to the email specified immediately.
<strong>Send Test Email:</strong> If you want to see the email as your customer would see it, you can enter your email address here and click “Send.” The campaign will be sent to the email specified immediately.

{% info %}
To send a test email to more than one address, simply separate each address with a comma. You can send test emails to no more than 10 different addresses.
Expand Down
2 changes: 1 addition & 1 deletion source/User_Guide/Suppressions/global_unsubscribes.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ When you add the ```<%asm_global_unsubscribe_url%>``` tag to your email, we will
Using the API
{% endanchor %}

You can manage your Global Unsubscribes via the [Advanced Suppression Manager Global Suppressions API]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/global_suppressions.html).
You can manage your Global Unsubscribes via the [Global Suppressions API]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/global_suppressions.html).

{% anchor h2 %}
Related
Expand Down
2 changes: 1 addition & 1 deletion source/User_Guide/Suppressions/group_unsubscribes.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ When you add the ```<%asm_group_unsubscribe_url%>``` tag to your email, we will
Using the API
{% endanchor %}

You can manage your Global Unsubscribes via the [Advanced Suppression Manager Group Suppressions API]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/groups.html).
You can manage your Global Unsubscribes via the [Group Suppressions API]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/groups.html).

{% anchor h2 %}
Related
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ navigation:
show: true
---

Emails that are sent with an ASM group specified with will have two links at the bottom of the email: an “Email Preferences” link, and an “Unsubscribe” link.
Emails that are sent with an unsubscribe group specified with will have two links at the bottom of the email: an “Email Preferences” link, and an “Unsubscribe” link.

If you do not specify a unsubscribe group when sending an email, the unsubscribe link will act as a global unsubscribe. This means that the recipient will no longer get any emails at all, including potentially important emails like password resets. To avoid this, create unsubscribe groups.

Expand All @@ -24,7 +24,7 @@ When a recipient clicks the Unsubscribe link, they will be asked to confirm thei
The Email Preferences Link
{% endanchor %}

If you choose not to use substitution tags, your emails will automatically have am Email Preferences link, which when clicked will show recipients their personalized Email Preferences page. From here, recipients will be able to see all of your ASM groups and their descriptions. They will then be able to choose whether or not they want to receive those types of emails.
If you choose not to use substitution tags, your emails will automatically have am Email Preferences link, which when clicked will show recipients their personalized Email Preferences page. From here, recipients will be able to see all of your Unsubscribe Groups and their descriptions. They will then be able to choose whether or not they want to receive those types of emails.

{% anchor h3 %}
Manage Email Preferences
Expand Down
4 changes: 2 additions & 2 deletions source/User_Guide/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ Transactional Emails
This box shows you the information for sending transactional emails via SendGrid’s [SMTP Relay]({{root_url}}/Glossary/smtp_relay.html). Your API Key is only shown once, when you create it, so it will not be shown on your dashboard.

{% anchor h2 %}
Advanced Suppression Manager
Unsubscribe Groups
{% endanchor %}

The advanced suppression manager box will show you the current status of suppression groups in your account. From here you can click links to [manage]({{site.app_url}}/suppressions/advanced_suppression_manager) and integrate your suppression groups.
The Unsubscribe Groups box will show you the current status of unsubscribe groups in your account. From here you can click links to [manage]({{site.app_url}}/suppressions/advanced_suppression_manager) and integrate your unsubscribe groups.

{% anchor h2 %}
Help Links
Expand Down