From 43dc39535fb92ca7ab9f44d629beca470ef540bf Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Wed, 1 Jun 2016 17:17:59 -0600 Subject: [PATCH 01/14] added undocumented ASM endpoints --- .../Suppression_Management/suppressions.md | 121 +++++++++++++++++- 1 file changed, 119 insertions(+), 2 deletions(-) diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md index 161589c76b..72c4f08c18 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md @@ -8,6 +8,79 @@ navigation: 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. +{% anchor h2 %} +GET +{% endanchor %} + +Get all suppressions. + +{% apiv3example get GET https://api.sendgrid.com/v3/asm/suppressions %} +{% v3response %} +HTTP/1.1 200 +[ + { + "email":"test1@example.com", + "group_id": 1, + "group_name": "Weekly News", + "created_at": 1410986704 + }, + { + "email":"test1@example.com", + "group_id": 2, + "group_name": "Daily News", + "created_at": 1411493671 + }, + { + "email":"test2@example.com", + "group_id": 2, + "group_name": "Daily News", + "created_at": 1411493671 + } +] +{% endv3response %} +{% endapiv3example %} + +{% anchor h2 %} +GET +{% endanchor %} + +Get a list of all unsubscribe groups that the given address belongs to. + +{% parameters post %} + {% parameter email Yes 'String' 'Email address to search for across all groups.' %} +{% endparameters %} + +{% apiv3example get GET https://api.sendgrid.com/v3/asm/suppressions/{email} %} +{% v3response %} +HTTP/1.1 200 +{ + "suppressions": [ + { + "description": "Optional description.", + "id": 1, + "is_default": true, + "name": "Weekly News", + "suppressed": true + }, + { + "description": "Some daily news.", + "id": 2, + "is_default": true, + "name": "Daily News", + "suppressed": true + }, + { + "description": "An old group.", + "id": 2, + "is_default": false, + "name": "Old News", + "suppressed": false + } + ] +} +{% endv3response %} +{% endapiv3example %} + {% anchor h2 %} POST {% endanchor %} @@ -25,7 +98,12 @@ If the group has been deleted, this request will add the address to the global s {% apiv3example post POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions recipient_emails=['test1@example.com','test2@example.com'] %} {% v3response %} HTTP/1.1 201 -{"recipient_emails":["test1@example.com","test2@example.com"]} +{ + "recipient_emails": [ + "test1@example.com", + "test2@example.com" + ] +} {% endv3response %} {% endapiv3example %} @@ -40,7 +118,10 @@ Get suppressed addresses for a given group. {% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions %} {% v3response %} HTTP/1.1 200 -["test1@example.com","test2@example.com"] +[ + "test1@example.com", + "test2@example.com" +] {% endv3response %} {% endapiv3example %} @@ -57,3 +138,39 @@ Delete a recipient email from the suppressions list for a group. HTTP/1.1 204 {% endv3response %} {% endapiv3example %} + +{% anchor h2 %} +POST +{% endanchor %} + +Use this endpoint to determine if a given list of emails exists in the given suppression group. +This endpoint will return a subset of emails from the request that exists in the suppression group. + +{% parameters post %} + {% parameter group_id Yes 'integer' 'The ID of the group that you would like to search.' %} +{% endparameters %} + +{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions %} + +{% apiv3requestbody %} +{ + "recipient_emails": [ + "exists1@example.com", + "exists2@example.com", + "doesnotexists@example.com" + ] +} +{% endapiv3requestbody %} + +{% v3response %} +HTTP/1.1 200 + +{ + "recipient_emails":[ + "exists1@example.com", + "exists2@example.com" + ] +} + +{% endv3response %} +{% endapiv3example %} From 50e59d844af17a0e51285dd5fb75c8036199554a Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Mon, 6 Jun 2016 11:00:15 -0600 Subject: [PATCH 02/14] added new endpoints docs to ASM group --- .../Suppression_Management/groups.md | 41 +++++++++++++++++++ .../Suppression_Management/suppressions.md | 2 +- 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/groups.md b/source/API_Reference/Web_API_v3/Suppression_Management/groups.md index 5b80c24d72..d65a4c0857 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/groups.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/groups.md @@ -117,6 +117,47 @@ HTTP/1.1 201 OK * * * * * +{% anchor h2 %} +GET +{% endanchor %} + +Retrieve information about multiple suppression groups. + +This endpoint will return information for each group ID that you include in your request. To add a group ID to your request, simply append `&id=` followed by the group ID. + +{% parameters get %} + {% parameter id No Integer 'ID for a suppression group that you want to retrieve information for.' %} +{% endparameters %} + +{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups?id={id1}&id={id2} %} + +{% v3response %} +HTTP/1.1 200 OK + +[ + { + "id": 100, + "name": "Newsletters", + "description": "Our monthly newsletter.", + "last_email_sent_at": null, + "is_default" : true, + "unsubscribes": 400 + }, + { + "id": 101, + "name": "Alerts", + "description 2": "Emails triggered by user-defined rules.", + "last_email_sent_at": null, + "is_default" : false, + "unsubscribes": 1 + } +] +{% endv3response %} + +{% endapiv3example %} + +* * * * * + {% anchor h2 %} DELETE {% endanchor %} diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md index 72c4f08c18..37907945b1 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md @@ -144,7 +144,7 @@ POST {% endanchor %} Use this endpoint to determine if a given list of emails exists in the given suppression group. -This endpoint will return a subset of emails from the request that exists in the suppression group. +This endpoint will return a subset of emails from the request that exist in the suppression group. {% parameters post %} {% parameter group_id Yes 'integer' 'The ID of the group that you would like to search.' %} From e0d0cd5f3a8944402df442612132313036e60167 Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Mon, 6 Jun 2016 16:20:49 -0600 Subject: [PATCH 03/14] added ASM endpoint docs --- .../Web_API_v3/Suppression_Management/groups.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/groups.md b/source/API_Reference/Web_API_v3/Suppression_Management/groups.md index d65a4c0857..f7583f38b5 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/groups.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/groups.md @@ -29,7 +29,16 @@ There is a limit of 25 groups per user. {% endparameters %} {% apiv3example post POST https://api.sendgrid.com/v3/asm/groups name=Product+Suggestions&description=Suggestions+for+products+our+users+might+like. %} - {% v3response %} + +{% apiv3requestbody %} +{ + "name": "Product Suggestions", + "description": "Suggestions for products our users might like.", + "is_default": true +} +{% endapiv3requestbody %} + +{% v3response %} HTTP/1.1 201 OK { From 085848dc6f82699cf7b12ad3cba31d043cbce669 Mon Sep 17 00:00:00 2001 From: Zaftula Date: Fri, 10 Jun 2016 09:14:25 -0600 Subject: [PATCH 04/14] Update index.html Changing header for proper search result format. Removed old sales number. --- source/User_Guide/SendGrid_for_Mobile/index.html | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/source/User_Guide/SendGrid_for_Mobile/index.html b/source/User_Guide/SendGrid_for_Mobile/index.html index 613ef48cc5..c91829b17f 100644 --- a/source/User_Guide/SendGrid_for_Mobile/index.html +++ b/source/User_Guide/SendGrid_for_Mobile/index.html @@ -1,16 +1,18 @@ --- -layout: page -weight: 900 -title: Overview +st: + published_at: 2016-06-10 + type: User_Guide seo: - title: SendGrid for iPhone and iPad Overview - description: Read about the SendGrid iPhone mobile app and how to use it. + title: SendGrid for mobile + description: Read about the SendGrid mobile app and how to use it. + keywords: iphone, ipad, ios, android, google +title: SendGrid for mobile navigation: show: true --- {% anchor h2 %} -What is SendGrid for Mobile? +What is SendGrid for mobile? {% endanchor %}

@@ -32,7 +34,7 @@

  • An Android device, iPhone, iPod Touch, or iPad with iOS 8 or later
    • -
  • A SendGrid account is required. You can sign up on our website or contact our friendly sales team at 888-985-7363.
    • +
  • A SendGrid account is required. If you don't have an account, You can sign up for one here.

From eb12b7465bbaa1b217d2f1bce0ef602d2e1cc252 Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Mon, 13 Jun 2016 11:50:03 -0600 Subject: [PATCH 05/14] fixed typos in URL and request example --- .../Web_API_v3/Suppression_Management/suppressions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md index 37907945b1..1a40059f3a 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md @@ -150,7 +150,7 @@ This endpoint will return a subset of emails from the request that exist in the {% parameter group_id Yes 'integer' 'The ID of the group that you would like to search.' %} {% endparameters %} -{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions %} +{% apiv3example post POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/search %} {% apiv3requestbody %} { From 598fb5b4c258c4c7e5a6555b82445a00174bfbd8 Mon Sep 17 00:00:00 2001 From: Zaftula Date: Mon, 13 Jun 2016 15:53:52 -0600 Subject: [PATCH 06/14] Delete your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.md Article no longer relevant as emails are no longer sent to users for this particular process. --- ...at_risk_for_suspension_what_should_i_do.md | 43 ------------------- 1 file changed, 43 deletions(-) delete mode 100644 source/Classroom/Troubleshooting/Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.md diff --git a/source/Classroom/Troubleshooting/Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.md b/source/Classroom/Troubleshooting/Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.md deleted file mode 100644 index c86ebba0b1..0000000000 --- a/source/Classroom/Troubleshooting/Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -seo: - title: I got an email saying, "Your SendGrid Account Is At Risk For Suspension". What should I do? - description: I got an email saying, "Your SendGrid Account Is At Risk For Suspension". What should I do? - keywords: risk, suspension, Your SendGrid Account Is At Risk For Suspension -title: I got an email saying, "Your SendGrid Account Is At Risk For Suspension". What should I do? -weight: 0 -layout: page -zendesk_id: 204804157 -navigation: - show: true ---- - -When you get an email like this, it means that our system noticed that your deliverability rates (delivered events / processed events) have dropped, or that you received complaints (spam reports) from you clients. - -Don't worry though, this is simply a precautionary warning. No need to be alarmed! - - - -**What should you do?** - -- **Check your email activity:** You should take a close look at your recent email activity logs by using the [Stats Dashboard](https://sendgrid.com/statistics/overview). There, you would have to check your Bounce / Spam Report / Invalid Email Rates. All of these could affect your reputation as a sender. - - - -![]({{root_url}}/images/Selection_028.png) - -- **How to resolve the problem:** - - - **Remove the bounces / spam reports / invalid emails from your mailing lists** : It is important that you remove these kind of addresses, to avoid sending emails to them again, and further damage your reputation. A nifty tool that can help you a lot with this is [List Assist](https://sendgrid.com/docs/Utilities/list_assist.html). A video tutorial of the List Assist tool can be found [here](https://sendgrid.com/docs/VidGrid/Tools/listassist.html). - - **Monitor your stats:** check your email activity stats regularly, making sure that you do not get bounces / spam reports events at all. When you do see such an event, make sure that you check out the [Email Activity](https://sendgrid.com/logs/index) page, and see exactly what went wrong with specific emails. Setting up a Stats Notification alert from your [Alert Settings](https://sendgrid.com/alerts) page of your account can save you a lot of trouble, as we can automatically provide you details about your email activity at your desired frequency, via email. - -Do we have any kind of threshold at which the accounts get suspended? - -Although some settings have been made in our server for this, we cannot disclose that information as it is part of our secret sauce. - -I did all the things that have been asked from me, but I still got suspended. - -In this situation you most probably received an email already from our Compliance & Abuse team. Please reply to that email in order to get in touch with them and have things cleared out, and re-activate your account. More information about suspended accounts can be found [here]({{root_url}}/Classroom/Troubleshooting/Account_Administration/account_under_review_suspended.html). - -Happy sending! - - From 9e5cf477d8109c694bb7b766f36c108a379324a7 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Tue, 14 Jun 2016 11:41:04 -0600 Subject: [PATCH 07/14] Remove the link to this page. --- source/Utilities/code_workshop.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 source/Utilities/code_workshop.md diff --git a/source/Utilities/code_workshop.md b/source/Utilities/code_workshop.md deleted file mode 100644 index 584f056d32..0000000000 --- a/source/Utilities/code_workshop.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -layout: iframe -title: Code Workshop -footer: false -weight: 100 -navigation: - show: true ---- - From 65bd88efcf939e3c647697fd31bc689a2b516bac Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Tue, 14 Jun 2016 12:02:00 -0600 Subject: [PATCH 08/14] removed link to code workshop --- source/User_Guide/Transactional_Email/index.html | 1 - 1 file changed, 1 deletion(-) diff --git a/source/User_Guide/Transactional_Email/index.html b/source/User_Guide/Transactional_Email/index.html index 5f9916b680..4b8a5d0c47 100644 --- a/source/User_Guide/Transactional_Email/index.html +++ b/source/User_Guide/Transactional_Email/index.html @@ -25,7 +25,6 @@

From 2bdc1d5e285942239f4c7a04c65873b599777af1 Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Tue, 14 Jun 2016 12:02:52 -0600 Subject: [PATCH 09/14] removed code workshop The code workshop is gone. --- source/Utilities/index.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/Utilities/index.md b/source/Utilities/index.md index e6afbb0083..5f56a341a1 100644 --- a/source/Utilities/index.md +++ b/source/Utilities/index.md @@ -12,8 +12,6 @@ your email. Our Brand New [Deliverability Center]({{root_url}}/Utilities/deliverabilitycenter.html) is live and ready to help! Come check out our growing library of bounce errors and their solutions! -Check out [Code Workshop]({{root_url}}/Utilities/code_workshop.html) to -generate email-sending code in a variety of languages. The [SMTP API header validator]({{root_url}}/Utilities/smtpapi_validator.html) will help ensure that the SMTP API header you are using is valid. From 69124e1b917db8ae3d061318b9a022f9581ccba1 Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Tue, 14 Jun 2016 15:11:35 -0600 Subject: [PATCH 10/14] copy edits to suppressions endoints --- .../Suppression_Management/suppressions.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md index 37907945b1..22445693d3 100644 --- a/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md +++ b/source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md @@ -6,7 +6,7 @@ navigation: show: true --- -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. +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. {% anchor h2 %} GET @@ -19,7 +19,7 @@ Get all suppressions. HTTP/1.1 200 [ { - "email":"test1@example.com", + "email":"test@example.com", "group_id": 1, "group_name": "Weekly News", "created_at": 1410986704 @@ -44,7 +44,7 @@ HTTP/1.1 200 GET {% endanchor %} -Get a list of all unsubscribe groups that the given address belongs to. +Retrieve all unsubscribe groups that the given email address has been added to. {% parameters post %} {% parameter email Yes 'String' 'Email address to search for across all groups.' %} @@ -144,20 +144,21 @@ POST {% endanchor %} Use this endpoint to determine if a given list of emails exists in the given suppression group. -This endpoint will return a subset of emails from the request that exist in the suppression group. + +When given a list of email addresses and a group ID, this endpoint will return only the email addresses that have been unsubscribed from the given group. {% parameters post %} {% parameter group_id Yes 'integer' 'The ID of the group that you would like to search.' %} {% endparameters %} -{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions %} +{% apiv3example get GET https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/search %} {% apiv3requestbody %} { "recipient_emails": [ - "exists1@example.com", - "exists2@example.com", - "doesnotexists@example.com" + "test1@example.com", + "test2@example.com", + "test3@example.com" ] } {% endapiv3requestbody %} @@ -167,8 +168,8 @@ HTTP/1.1 200 { "recipient_emails":[ - "exists1@example.com", - "exists2@example.com" + "test1@example.com", + "test2@example.com" ] } From 91c8e31179c8b914a1a2b5db915fdf6689b34c8a Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Tue, 14 Jun 2016 15:23:35 -0600 Subject: [PATCH 11/14] Removed link to deleted Classroom article Removed the link to /Classroom/Troubleshooting/Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.html * This article is out of date, and is being removed from the Classroom --- source/Classroom/Troubleshooting/index.html | 1 - 1 file changed, 1 deletion(-) diff --git a/source/Classroom/Troubleshooting/index.html b/source/Classroom/Troubleshooting/index.html index d6c17d2567..c47732e35d 100644 --- a/source/Classroom/Troubleshooting/index.html +++ b/source/Classroom/Troubleshooting/index.html @@ -45,7 +45,6 @@

Authentication, Em
  • My provision was declined, what should I do?
  • Upgrade error message: "You cannot change your package at this time because your account is not active."
  • "Your account is still being provisioned, you may not be able to send emails"
    • -
  • I got an email saying, "Your SendGrid Account Is At Risk For Suspension". What should I do?
    • From 807113377a5c49caaab350eeee42f875f421cee3 Mon Sep 17 00:00:00 2001 From: Eric Schallock Date: Tue, 14 Jun 2016 15:46:59 -0600 Subject: [PATCH 12/14] removed extra space in indented frontmatter --- source/User_Guide/SendGrid_for_Mobile/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/User_Guide/SendGrid_for_Mobile/index.html b/source/User_Guide/SendGrid_for_Mobile/index.html index c91829b17f..832ac0d3dd 100644 --- a/source/User_Guide/SendGrid_for_Mobile/index.html +++ b/source/User_Guide/SendGrid_for_Mobile/index.html @@ -5,7 +5,7 @@ seo: title: SendGrid for mobile description: Read about the SendGrid mobile app and how to use it. - keywords: iphone, ipad, ios, android, google + keywords: iphone, ipad, ios, android, google title: SendGrid for mobile navigation: show: true From 64122ddcf92ac00a02928f835549a53e5bb6178d Mon Sep 17 00:00:00 2001 From: bhammerquist Date: Wed, 15 Jun 2016 09:40:31 -0600 Subject: [PATCH 13/14] Update spam_traps.md Changing article link to Classroom doc instead of support site article. --- source/Glossary/spam_traps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Glossary/spam_traps.md b/source/Glossary/spam_traps.md index 278fe5ba45..120c2aedb8 100644 --- a/source/Glossary/spam_traps.md +++ b/source/Glossary/spam_traps.md @@ -14,6 +14,6 @@ Spam traps, also called a “honeypots”, are email addresses created (or re-ac Spam traps are important because so many large ISPs, spam filter providers and Domain Name System [blacklists]({{root_url}}/Glossary/blacklists.html) use them. In short, sending an email to a spam trap can lead directly to being blacklisted by the organization that set up the trap. Remember that blacklisting can ruin a business’s reputation and halt further email deliverability. -This [article]({{site.support_url}}/hc/en-us/articles/200182968) from our Support Help Center goes into specific details about spam traps. +This [article]({{root_url}}/Classroom/Deliver/Undeliverable_Email/spam_trapped.html) from our Support Help Center goes into specific details about spam traps. [To get even more information please check out our Email Infrastructure Guide.](http://resources.sendgrid.com/email-infrastructure-guide/?mc=SendGrid%20Documentation) From cd0fe109763c62633f2e85f88c7d6128b1bff944 Mon Sep 17 00:00:00 2001 From: Cody Clark Date: Thu, 16 Jun 2016 12:00:41 -0600 Subject: [PATCH 14/14] Corrected Hyperlink Linked to Webhooks page before Now links to Inbound Parse --- source/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/index.html b/source/index.html index 3caa937746..d890d60fae 100644 --- a/source/index.html +++ b/source/index.html @@ -90,7 +90,7 @@

    Event Webhook

    - +

    Inbound Parse

    Programmatically parse incoming emails.