Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.

Commit 072cd40

Browse files
author
Matt Bernier
committed
Merge pull request #982 from sendgrid/develop
ASM pages ✅
2 parents 63fa1e9 + b1a4ae0 commit 072cd40

File tree

17 files changed

+573
-22
lines changed

17 files changed

+573
-22
lines changed

‎source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Guide]({{root_url}}/User_Guide/Email_Deliverability/Subscription_Tracking/index.
1414
check out the following API resources:
1515

1616
-[Suppression
17-
Group]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html) This resource provides an overview on how to use groups which are individual types of email you would like your users to be able to unsubscribe from.
17+
Group]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html) This resource provides an overview on how to use groups, which are individual types of email, that you would like your users suppressed from.
1818

1919
-[Suppressions]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/suppressions.html) This resource will show you how to use supressions which are email addresses that can be added to groups to prevent certain types of emails from being delivered to those addresses
2020

‎source/API_Reference/Web_API_v3/Unsubscribe_Manager/global_unsubscribes.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
layout: page
3+
title: Global Unsubscribes
4+
weight: 70
5+
navigation:
6+
show: true
7+
---
8+
9+
Global Unsubscribes are email addresses that will not receive any
10+
emails.
11+
12+
{% anchor h2 %}
13+
POST
14+
{% endanchor %}
15+
16+
Add recipient addresses to the global unsubscribe group.
17+
18+
{% parameters post %}
19+
{% parameter recipient_emails Yes 'Array of valid email addresses' 'Addresses to add to the global unsubscribe group' %}
20+
{% endparameters %}
21+
22+
{% apiv3example post POST https://api.sendgrid.com/v3/asm/suppressions/global recipient_emails=['[email protected]','[email protected]'] %}
23+
{% v3response %}
24+
HTTP/1.1 201
25+
{"recipient_emails":["[email protected]","[email protected]"]}
26+
{% endv3response %}
27+
{% endapiv3example %}
28+
29+
* * * * *
30+
31+
{% anchor h2 %}
32+
GET
33+
{% endanchor %}
34+
35+
Check if a recipient address is in the global unsubscribes group.
36+
37+
{% apiv3example get GET https://api.sendgrid.com/v3/asm/suppressions/global/:email_address %}
38+
{% v3response %}
39+
HTTP/1.1 200
40+
{
41+
"recipient_email": "[email protected]"
42+
}
43+
{% endv3response %}
44+
{% endapiv3example %}
45+
46+
* * * * *
47+
48+
{% anchor h2 %}
49+
DELETE
50+
{% endanchor %}
51+
52+
Delete a recipient email from the global unsubscribes group.
53+
54+
{% apiv3example get DELETE https://api.sendgrid.com/v3/asm/suppressions/global/:email_address %}
55+
{% v3response %}
56+
HTTP/1.1 204
57+
{% endv3response %}
58+
{% endapiv3example %}

‎source/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.md‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
layout: page
3+
title: Groups
4+
weight: 90
5+
navigation:
6+
show: true
7+
---
8+
9+
Groups are specific types of email you would like your recipients to be able to unsubscribe from or subscribe to. For example: Daily Newsletters, Invoices, System Alerts.
10+
11+
{% info %}
12+
The `name` and `description` of the Group will be visible by recipients when they are managing their subscriptions.
13+
{% endinfo %}
14+
15+
{% anchor h2 %}
16+
POST
17+
{% endanchor %}
18+
Create a new unsubscribe group.
19+
20+
{% info %}
21+
There is a limit of 25 groups per user.
22+
{% endinfo %}
23+
24+
{% parameters post %}
25+
{% parameter name Yes 'String. May not share its name with any other unsubscribe group on the user. Max 30 characters' 'The name of the new unsubscribe group' %}
26+
{% parameter description Yes 'String. Max 100 characters' 'A description of the unsubscribe group' %}
27+
{% endparameters %}
28+
29+
{% apiv3example post POST https://api.sendgrid.com/v3/asm/groups name=Product+Suggestions&description=Suggestions+for+products+our+users+might+like. %}
30+
{% v3response %}
31+
HTTP/1.1 201 OK
32+
33+
{
34+
"id":103,
35+
"name": "Product Suggestions",
36+
"description": "Suggestions for products our users might like.",
37+
"last_email_sent_at": "NOT IMPLEMENTED"
38+
}
39+
{% endv3response %}
40+
{% endapiv3example %}
41+
42+
* * * * *
43+
44+
{% anchor h2 %}
45+
GET
46+
{% endanchor %}
47+
Retrieve all unsubscribe groups associated with the user.
48+
49+
{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups %}
50+
{% v3response %}
51+
[
52+
{
53+
"id": 100,
54+
"name": "Newsletters",
55+
"description": "Our monthly newsletter.",
56+
"last_email_sent_at": "2014-09-04 01:34:43",
57+
"unsubscribes": 400
58+
},
59+
{
60+
"id": 101,
61+
"name": "Alerts",
62+
"description 2": "Emails triggered by user-defined rules.",
63+
"last_email_sent_at": "2012-11-06 09:37:33",
64+
"unsubscribes": 1
65+
}
66+
]
67+
{% endv3response %}
68+
{% endapiv3example %}
69+
70+
* * * * *
71+
72+
{% anchor h2 %}
73+
GET
74+
{% endanchor %}
75+
Get information on a single unsubscribe group.
76+
77+
{% apiv3example get-specific GET https://api.sendgrid.com/v3/asm/groups/:group_id %}
78+
{% v3response %}
79+
{
80+
"id": 100,
81+
"name": "Newsletters",
82+
"description": "Our monthly newsletter.",
83+
"last_email_sent_at": "2014-09-04 01:34:43",
84+
"unsubscribes": 400
85+
}
86+
{% endv3response %}
87+
{% endapiv3example %}
88+
89+
* * * * *
90+
91+
{% anchor h2 %}
92+
PATCH
93+
{% endanchor %}
94+
Update a unsubscribe group.
95+
96+
{% parameters patch %}
97+
{% parameter name No 'String. May not share its name with any other unsubscribe group on the user. Max 30 characters' 'The name of the new unsubscribe group' %}
98+
{% parameter description No 'String. Max 100 characters' 'A description of the unsubscribe group' %}
99+
{% endparameters %}
100+
101+
{% apiv3example patch PATCH https://api.sendgrid.com/v3/asm/groups/:group_id name=Item+Suggestions&description=Suggestions+for+items+our+users+might+like. %}
102+
{% v3response %}
103+
HTTP/1.1 201 OK
104+
105+
{
106+
"id":103,
107+
"name": "Item Suggestions",
108+
"description": "Suggestions for items our users might like.",
109+
"last_email_sent_at": "2014-09-05 03:14:15"
110+
}
111+
{% endv3response %}
112+
{% endapiv3example %}
113+
114+
* * * * *
115+
116+
{% anchor h2 %}
117+
DELETE
118+
{% endanchor %}
119+
Delete a unsubscribe group.
120+
121+
{% info %}
122+
You can only delete groups that have not been attached to sent mail in the last 60 days.
123+
If a recipient uses the "one-click unsubscribe" option on an email
124+
associated with a deleted group, that recipient will be added to the
125+
global unsubscribe list.
126+
{% endinfo %}
127+
128+
{% apiv3example delete DELETE https://api.sendgrid.com/v3/asm/groups/:group_id %}
129+
{% v3response %}
130+
HTTP/1.1 204 NO CONTENT (OK)
131+
{% endv3response %}
132+
{%v3response %}
133+
HTTP/1.1 400
134+
135+
{
136+
"error":"refusing to delete active group: group has been sent to within the past 60 days"
137+
}
138+
{% endv3response %}
139+
{% endapiv3example %}

‎source/API_Reference/Web_API_v3/Unsubscribe_Manager/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
layout: page
3+
title: Unsubscribe Manager Overview
4+
weight: 100
5+
navigation:
6+
show: true
7+
---
8+
9+
Unsubscribe Managers gives your recipients more control over the types of emails they want to receive by letting them opt out of messages from a
10+
certain group.
11+
12+
Learn more in the:[Unsubscribe Manager User
13+
Guide]({{root_url}}/User_Guide/Email_Deliverability/Subscription_Tracking/index.html), or
14+
check out the following API resources:
15+
16+
-[Unsubscribe
17+
Group]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html) This resource provides an overview on how to use groups which are individual types of email you would like your users to be able to unsubscribe from.
18+
19+
-[Unsubscribes]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/unsubscribes.html) This resource will show you how to use supressions which are email addresses that can be added to groups to prevent certain types of emails from being delivered to those addresses
20+
21+
-[Global Unsubscribes]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/global_unsubscribes.html) This resource will show you how to use global unsubscribes which are email addresses that will not receive any emails

‎source/API_Reference/Web_API_v3/Unsubscribe_Manager/unsubscribes.md‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
---
2+
layout: page
3+
title: Unsubscribes
4+
weight: 80
5+
navigation:
6+
show: true
7+
---
8+
9+
Unsubscribes are email addresses that can be added to [groups]({{ root_url }}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html) to prevent certain types of emails from being delivered to those addresses.
10+
11+
{% anchor h2 %}
12+
POST
13+
{% endanchor %}
14+
15+
Add recipient addresses to the unsubscribes list for a given group.
16+
17+
{% info %}
18+
If the group has been deleted, this request will add the address to the global unsubscribe.
19+
{% endinfo %}
20+
21+
{% parameters post %}
22+
{% parameter recipient_emails Yes 'Array of valid email addresses' 'Addresses to add to the unsubscribe group' %}
23+
{% endparameters %}
24+
25+
{% apiv3example post POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions recipient_emails=['[email protected]','[email protected]'] %}
26+
{% v3response %}
27+
HTTP/1.1 201
28+
{"recipient_emails":["[email protected]","[email protected]"]}
29+
{% endv3response %}
30+
{% endapiv3example %}
31+
32+
* * * * *
33+
34+
{% anchor h2 %}
35+
GET
36+
{% endanchor %}
37+
38+
Get suppressed addresses for a given group.
39+
40+
{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions %}
41+
{% v3response %}
42+
HTTP/1.1 200
43+
{"recipient_emails":["[email protected]","[email protected]"]}
44+
{% endv3response %}
45+
{% endapiv3example %}
46+
47+
* * * * *
48+
49+
{% anchor h2 %}
50+
GET
51+
{% endanchor %}
52+
53+
Get unsubscribe groups associated with a given recipient address.
54+
55+
{% apiv3example get GET https://api.sendgrid.com/v3/asm/suppressions/:email_address %}
56+
{% v3response %}
57+
HTTP/1.1 200
58+
{
59+
"suppressions": [
60+
{
61+
"id": 1,
62+
"name": "Weekly Newsletter",
63+
"description": "The weekly newsletter",
64+
"suppressed": false
65+
},
66+
{
67+
"id": 4,
68+
"name": "Special Offers",
69+
"description": "Special offers and coupons",
70+
"suppressed": false
71+
}
72+
]
73+
}
74+
{% endv3response %}
75+
{% endapiv3example %}
76+
77+
* * * * *
78+
79+
{% anchor h2 %}
80+
DELETE
81+
{% endanchor %}
82+
83+
Delete a recipient email from the unsubscribes list for a group.
84+
85+
{% apiv3example get DELETE https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/:email_address %}
86+
{% v3response %}
87+
HTTP/1.1 204
88+
{% endv3response %}
89+
{% endapiv3example %}
90+

‎source/User_Guide/Email_Deliverability/Subscription_Tracking/advanced_suppression_manager.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
seo:
3-
title: Advanced Suppression Manager
4-
title: Advanced Suppression Manager
3+
title: Unsubscribe Manager
4+
title: Unsubscribe Manager
55
weight: 0
66
layout: page
77
navigation:
@@ -21,7 +21,7 @@ is still in your contact database or you can send this contact's email via the A
2121

2222
For example, if you had an outdated email list and sent an email to that list, but a user on that list had previously unsubscribed from that type of email from you, they would not get the email because the email
2323
would never leave SendGrid. It would be suppressed from being sent. A contact's emails will only be suppressed if they unsubscribe from that sender's emails, unsubscribing from one sender's list will have no effect
24-
on suppression lists owned by other senders.
24+
on unsubscribe lists owned by other senders.
2525

2626
{% anchor h2 %}
2727
Overview
@@ -39,6 +39,6 @@ All of your groups will be visible on the Email Preferences page, along
3939
with the descriptions.
4040
{% endinfo %}
4141

42-
And of course there's [Advanced Suppression Manager API endpoints]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/index.html) for managing your groups and suppressions.
42+
And of course there's [Unsubscribe Manager API endpoints]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/index.html) for managing your groups and unsubscribes.
4343

4444

‎source/User_Guide/Email_Deliverability/Subscription_Tracking/defining_asm_groups.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
seo:
33
title: Defining Unsubscribe Groups
4-
title: Defining ASM Groups
4+
title: Defining Unsubscribe Groups
55
weight: 0
66
layout: page
77
navigation:
@@ -12,18 +12,18 @@ navigation:
1212
To Create ASM Groups
1313
{% endanchor %}
1414

15-
After logging in to your SendGrid account, click on the beta invitation banner at the top of the page. Once in the beta SendGrid Customer Portal, click on the clipboard icon on the left navigation bar and select "Advanced Suppression Manager."
15+
After logging in to your SendGrid account, click on the beta invitation banner at the top of the page. Once in the beta SendGrid Customer Portal, click on the clipboard icon on the left navigation bar and select "Advanced unsubscribe Manager."
1616

17-
From here you can begin creating suppression groups to define the types of emails for which you would like your recipients to be able to opt out.
17+
From here you can begin creating unsubscribe groups to define the types of emails for which you would like your recipients to be able to opt out.
1818

19-
You can also create ASM groups via the [API V3 > ASM Endpoint]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html#-POST).
19+
You can also create ASM groups via the [API V3 > ASM Endpoint]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html#-POST).
2020

2121

2222
{% anchor h2 %}
2323
Active and Inactive Groups
2424
{% endanchor %}
2525

26-
A group is active if email has been sent using that suppression group in the last 60 days. Active groups may not be deleted.
26+
A group is active if email has been sent using that unsubscribe group in the last 60 days. Active groups may not be deleted.
2727

2828

2929
{% anchor h2 %}
@@ -46,5 +46,5 @@ You may only specify one group per send, and you should wait one minute after cr
4646
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/Advanced_Suppression_Manager/groups.html#-GET) of the groups resource.
4747

4848
{% info %}
49-
You can create ASM groups via the [API V3 > ASM Endpoint]({{root_url}}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html#-POST).
49+
You can create ASM groups via the [API V3 > ASM Endpoint]({{root_url}}/API_Reference/Web_API_v3/Unsubscribe_Manager/groups.html#-POST).
5050
{% endinfo %}

0 commit comments

Comments
 (0)