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

Commit abc6a27

Browse files
committed
Change Global Suppression(s) to Global Unsubscribes
To reduce confusion I thought it would be best to use the same words and terminology that appears in the SendGrid dashboard. When the API docs talk about Global Suppressions there is a slight disconnect that this is referring to the Global Unsubscribes found in the Dashboard. In the User Guide Doc, under the Supporessions section, Global Unsubscribes are mentioned (which correlates to the Dahsboard). "Global Suppressions" isn't really found anywhere else in SendGrid's documention.
1 parent 1575074 commit abc6a27

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed
Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
---
22
layout: page
3-
title: Global Suppressions
3+
title: Global Unsubscribes
44
weight: 70
55
navigation:
66
show: true
77
---
88
FORMAT: 1A
99

10-
# Group Global Suppressions
11-
Global Suppressions are email addresses that will not receive any emails.
10+
# Group Global Unsubscribes
11+
Global Unsubscribes are email addresses that will not receive any emails.
1212

13-
## Global Suppressions Collection [/asm/suppressions/global]
13+
## Global Unsubscribes Collection [/asm/suppressions/global]
1414

15-
### Add a Global Suppression [POST]
15+
### Add email addresses to the Global Unsubscribes collection [POST]
1616
+ Request (application/json)
1717

1818
+ Body
@@ -30,22 +30,28 @@ Global Suppressions are email addresses that will not receive any emails.
3030

3131
{"recipient_emails":["[email protected]","[email protected]"]}
3232

33-
## Global Suppression [/asm/suppressions/{email}]
33+
## Global Unsubscribes [/asm/suppressions/{email}]
3434
+ Parameters
3535
+ email (required, string, `[email protected]`) ... The email to delete.
3636

37-
### Retrieve a Global Suppression [GET]
37+
### Determine if an email address belongs to the Global Unsubscribes collection [GET]
38+
39+
If the email address belongs to the Global Unsubscribes collection:
40+
3841
+ Response 200 (application/json)
3942

4043
+ Body
4144

42-
{
43-
"recipient_emails": [
44-
45-
46-
]
47-
}
45+
{ "recipient_email": "{email}" }
46+
47+
If the email address does not belongs to the Global Unsubscribes collection:
48+
49+
+ Response 200 (application/json)
50+
51+
+ Body
52+
53+
{ }
4854

49-
### Delete a Global Suppression [DELETE]
55+
### Remove an email address from the Global Unsubscribes collection [DELETE]
5056

5157
+ Response 204 (application/json)

0 commit comments

Comments
 (0)