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

Commit 5ef9621

Browse files
author
Matt Bernier
committed
Merge pull request #1292 from sendgrid/develop
ASM -> Unsub manager
2 parents c40450e + 6dd753b commit 5ef9621

File tree

21 files changed

+180
-77
lines changed

21 files changed

+180
-77
lines changed

source/API_Reference/Marketing_Emails_API/emails.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ Remove one or more emails from a Recipient List.
138138

139139
{% parameters delete %}
140140

141-
{% parameter list Yes 'Must be an existing Recipient List.' 'The list which you are adding email addresses too.' %}
141+
{% parameter list Yes 'Must be an existing Recipient List.' 'The list which you are removing email addresses from.' %}
142142
{% parameter email[] Yes 'Must be an email or emails in the Recipient List.' 'Specify the email address or email addresses you wish to remove from the specified Recipient List. May list multiple addresses with multiple <code>email[]</code> parameters' %}
143143
{% endparameters %}
144144

source/API_Reference/SMTP_API/suppressions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can specify up to 25 groups to display.
4545
Groups
4646
{% endanchor %}
4747

48-
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.
48+
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.
4949

5050
Related Articles:
5151

source/API_Reference/Web_API/filter_settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,8 +185,8 @@ All fields except version are required for each call.
185185
{% parameter 'group_unsubscribe' 'Yes' 'Notify when recipient unsubscribes from group' '1' %}
186186
{% parameter 'group_resubscribe' 'Yes' 'Notify when recipient resubscribes to group' '1' %}
187187
{% parameter 'spamreport' 'Yes' 'Notify when email is marked as spam' '1' %}
188-
{% parameter 'group_unsubscribe' 'Yes' 'Notify when email unsubscribes from an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html)' '1' %}
189-
{% parameter 'group_resubscribe' 'Yes' 'Notify when email resubscribes to an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html)' '1' %}
188+
{% parameter 'group_unsubscribe' 'Yes' 'Notify when email unsubscribes from an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
189+
{% parameter 'group_resubscribe' 'Yes' 'Notify when email resubscribes to an [ASM Group]({{root_url}}//API_Reference/Web_API_v3/Suppression_Management/groups.html)' '1' %}
190190
{% parameter 'url' 'Yes' 'The post notification url to post these event messages to' 'https://notificationurl.example.com/event' %}
191191
{% parameter 'version' 'No' 'The version of the Event API you wish to use. (1-3)' '3' %}
192192
{% endparameters %}

source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/index.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

source/API_Reference/Web_API_v3/Stats/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,20 @@
3232
<ul>
3333
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Blocks">Blocks</a></li>
3434
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Bounces-amp-Repeat-Bounces">Bounces</a></li>
35-
<li><a href="{{root_url}}/User_Guide/Email_Deliverability/Undelivered_Email/drops.html">Bounce Drops</a></li>
35+
<li><a href="{{root_url}}/Glossary/drops.html">Bounce Drops</a></li>
3636
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Clicks-amp-Unique-Clicks">Clicks</a></li>
3737
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Delivered">Delivered</a></li>
3838
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Deferrals">Deferrals</a></li>
39-
<li><a href="{{root_url}}/User_Guide/Email_Deliverability/Undelivered_Email/drops.html">Drops</a></li>
39+
<li><a href="{{root_url}}/Glossary/drops.html">Drops</a></li>
4040
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Invalid-email">Invalid Emails</a></li>
4141
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Opens-amp-Unique-Opens">Processed</a></li>
4242
<li><a href="{{root_url}}/API_Reference/Webhooks/parse.html">Received</a></li>
4343
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Requests">Requests</a></li>
4444
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Spam-reports-amp-repeat-spam-reports">Spam Reports</a></li>
4545
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Clicks-amp-Unique-Clicks">Unique Clicks</a></li>
4646
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Opens-amp-Unique-Opens">Unique Opens</a></li>
47-
<li><a href="{{root_url}}/User_Guide/Email_Deliverability/Undelivered_Email/drops.html">Spam Report Drops</a></li>
48-
<li><a href="{{root_url}}/User_Guide/Email_Deliverability/Undelivered_Email/drops.html">Unsubscribe Drops</a></li>
47+
<li><a href="{{root_url}}/Glossary/drops.html">Spam Report Drops</a></li>
48+
<li><a href="{{root_url}}/Glossary/drops.html">Unsubscribe Drops</a></li>
4949
<li><a href="{{root_url}}/User_Guide/Delivery_Metrics/metrics.html#-Unsubscribes">Unsubscribes</a></li>
5050
</ul>
5151

source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.md renamed to source/API_Reference/Web_API_v3/Suppression_Management/groups.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
layout: page
3-
title: Groups
3+
title: Unsubscribe Groups
44
weight: 90
55
navigation:
66
show: true
7+
title: Unsubscribe Groups
78
---
89

910
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.
@@ -43,7 +44,7 @@ HTTP/1.1 201 OK
4344
{% anchor h2 %}
4445
GET
4546
{% endanchor %}
46-
Retrieve all suppression groups associated with the user.
47+
Retrieve all suppression groups associated with the user.
4748

4849
{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups %}
4950
{% v3response %}
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: page
3+
title: Suppression Management Overview
4+
weight: 100
5+
navigation:
6+
show: true
7+
title: Overview
8+
keywords: advanced suppression manager, unsubscribe manager, customer unsubscribes, unsubscribe lists
9+
---
10+
11+
Unsubscribe Manager gives your recipients more control over the types of emails they want to receive by letting them opt out of messages from a certain type of email.
12+
13+
Learn more in the [Unsubscribe Manager User Guide]({{root_url}}/User_Guide/Suppressions/index.html), or check out the following API resources:
14+
15+
- [Suppression
16+
Group]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/groups.html) allow you to segment your email by a grouping which is most often defined by the types of email. Example: Receipts, Deals emails, and notification.
17+
18+
- [Suppressions]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/suppressions.html) Allow you to manually add or retrieve specific emails that are in your suppression groups.
19+
20+
- [Global Suppressions]({{root_url}}/API_Reference/Web_API_v3/Suppression_Management/global_suppressions.html) Allows you to keep all emails from going to a specific contact

source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/suppressions.md renamed to source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ navigation:
66
show: true
77
---
88

9-
Suppressions are email addresses that can be added to [groups]({{ root_url }}/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.html) to prevent certain types of emails from being delivered to those addresses.
9+
Suppressions are email addresses that can be added to [groups]({{ root_url }}/API_Reference/Web_API_v3/Suppression_Management/groups.html) to prevent certain types of emails from being delivered to those addresses.
1010

1111
{% anchor h2 %}
1212
POST
@@ -32,7 +32,7 @@ HTTP/1.1 201
3232
* * * * *
3333

3434
{% anchor h2 %}
35-
GET
35+
GET
3636
{% endanchor %}
3737

3838
Get suppressed addresses for a given group.
@@ -87,4 +87,3 @@ Delete a recipient email from the suppressions list for a group.
8787
HTTP/1.1 204
8888
{% endv3response %}
8989
{% endapiv3example %}
90-
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
layout: page
3+
weight: 100
4+
title: Bounces API
5+
seo:
6+
description: Manage your bounce list
7+
title: Bounce API
8+
navigation:
9+
show: true
10+
---
11+
FORMAT: 1A
12+
13+
# Bounces
14+
15+
## Bounces Collection [/v3/suppression/bounces?start_time={start_time}&end_time={end_time}]
16+
17+
+ Parameters
18+
19+
+ start_time (optional, number, `1443651141`) ... Refers start of the time range in unix timestamp when a bounce was created (inclusive).
20+
+ end_time (optional, number, `1443651154`) ... Refers end of the time range in unix timestamp when a bounce was created (inclusive).
21+
22+
### List all bounces [GET]
23+
24+
+ Response 200 (application/json)
25+
26+
+ Body
27+
28+
[
29+
{
30+
"created": 1443651125,
31+
"email": "[email protected]",
32+
"reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
33+
"status": "5.1.1"
34+
},
35+
{
36+
"created": 1433800303,
37+
"email": "[email protected]",
38+
"reason": "550 5.1.1 <[email protected]>: Recipient address rejected: User unknown in virtual alias table ",
39+
"status": "5.1.1"
40+
}
41+
]
42+
43+
## Bounces Collection [/v3/suppression/bounces]
44+
45+
There's two bounce delete options:
46+
1) deleting all bounces by specifying "delete_all" to true in the request body, or
47+
2) deleteing some emails by specificy "emails" and an array of emails in the response body.
48+
49+
### Delete bounces [DELETE]
50+
51+
+ Request (application/json)
52+
53+
+ Body
54+
55+
{
56+
"delete_all": true
57+
}
58+
59+
+ Response 204
60+
61+
+ Request (application/json)
62+
63+
+ Body
64+
65+
{
66+
"emails": [
67+
68+
69+
]
70+
}
71+
72+
+ Response 204
73+
74+
## Bounces Item [/v3/suppression/bounces/{email}]
75+
+ Parameters
76+
77+
+ email ('required', string, `[email protected]`) ... Email address of bounce entry to retrieve
78+
79+
### Get a bounce [GET]
80+
81+
+ Response 200 (application/json)
82+
83+
+ Body
84+
85+
[
86+
{
87+
"created": 1443651125,
88+
"email": "[email protected]",
89+
"reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
90+
"status": "5.1.1"
91+
}
92+
]
93+
94+
### Delete a bounce [DELETE]
95+
96+
+ Response 204

0 commit comments

Comments
 (0)