Skip to content

Commit 2f0e287

Browse files
Update documentation for Suppressions
1 parent 2f56209 commit 2f0e287

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

README.rst

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -248,17 +248,17 @@ List all API Keys belonging to the authenticated user.
248248
client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
249249
status, msg = client.apikeys.get()
250250
251-
`Advanced Suppression Manager (ASM)`_
251+
`Suppression Management`_
252252
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
253253

254-
Advanced Suppression 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.
254+
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.
255255

256256
More information_.
257257

258-
.. _information: https://sendgrid.com/docs/API_Reference/Web_API_v3/Advanced_Suppression_Manager/index.html
258+
.. _information: https://sendgrid.com/docs/API_Reference/Web_API_v3/Suppression_Management/index.html
259259

260-
ASM Groups
261-
~~~~~~~~~~
260+
Unsubscribe Groups
261+
~~~~~~~~~~~~~~~~~~~
262262

263263
Retrieve all suppression groups associated with the user.
264264

@@ -279,7 +279,7 @@ Create a new suppression group.
279279
280280
status, msg = client.asm_groups.post(name, description, is_default)
281281
282-
ASM Suppressions
282+
Suppressions
283283
~~~~~~~~~~~~~~~~
284284

285285
Suppressions are email addresses that can be added to groups to prevent certain types of emails from being delivered to those addresses.
@@ -305,7 +305,7 @@ Delete a recipient email from the suppressions list for a group.
305305
306306
status, msg = client.asm_suppressions.delete(<group_id>,<email_address>)
307307
308-
ASM Global Suppressions
308+
Global Suppressions
309309
~~~~~~~~~~~~~~~~~~~~~~~
310310

311311
Global Suppressions are email addresses that will not receive any emails.
@@ -318,6 +318,12 @@ Check if a given email is on the global suppression list.
318318
email = ['elmer@thinkingserious.com']
319319
status, msg = client.asm_global_suppressions.get(email)
320320
321+
Get a list of all SendGrid globally unsubscribed emails.
322+
323+
.. code:: python
324+
client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
325+
status, msg = client.suppressions.get()
326+
321327
Add an email to the global suppression list.
322328

323329
.. code:: python
@@ -332,15 +338,6 @@ Delete an email from the global suppression list.
332338
email = 'elmer@thinkingserious.com'
333339
status, msg = client.asm_global_suppressions.delete(email)
334340
335-
Suppression Unsubscribes
336-
~~~~~~~~~~~~~~~~~~~~~~~~
337-
338-
Get a list of all SendGrid globally unsubscribed emails.
339-
340-
.. code:: python
341-
client = sendgrid.SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))
342-
status, msg = client.suppressions.get()
343-
344341
SendGrid's `X-SMTPAPI`_
345342
-----------------------
346343

0 commit comments

Comments
 (0)