Merge pull request #1942 from sendgrid/develop

eschallock · web-flow · commit b07dc034a171 · 2016-06-16T15:34:47.000-06:00
6/16/2016 Docs Updates
diff --git 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
 
 {
@@ -117,6 +126,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
@@ -6,7 +6,80 @@ 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
+{% endanchor %}
+
+Get all suppressions.
+
+{% apiv3example get GET https://api.sendgrid.com/v3/asm/suppressions %}
+{% v3response %}
+HTTP/1.1 200
+[
+  {
+    "email":"test@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 %}
+
+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.' %}
+{% 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
@@ -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,40 @@ 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.
+
+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 post POST https://api.sendgrid.com/v3/asm/groups/:group_id/suppressions/search %}
+
+{% apiv3requestbody %}
+{
+  "recipient_emails": [
+    "test1@example.com",
+    "test2@example.com",
+    "test3@example.com"
+  ]
+}
+{% endapiv3requestbody %}
+
+{% v3response %}
+HTTP/1.1 200
+
+{
+  "recipient_emails":[
+    "test1@example.com",
+    "test2@example.com"
+  ]
+}
+
+{% endv3response %}
+{% endapiv3example %}
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
diff --git a/source/Classroom/Troubleshooting/index.html b/source/Classroom/Troubleshooting/index.html
@@ -45,7 +45,6 @@ <h2><a href="#Authentication-Email-Headers-and-Whitelabeling">Authentication, Em
             <li><a href="{{root_url}}Account_Administration/my_provision_was_declined_what_should_i_do.html">My provision was declined, what should I do?</a></li>
             <li><a href="{{root_url}}Account_Administration/you_cannot_change_your_package_at_this_time_because_your_account_is_not_active.html">Upgrade error message&#58; "You cannot change your package at this time because your account is not active."</a></li>
             <li><a href="{{root_url}}Account_Administration/your_account_is_still_being_provisioned_you_will_not_be_able_to_send_out_any_email.html">"Your account is still being provisioned, you may not be able to send emails"</a></li>
-            <li><a href="{{root_url}}Account_Administration/your_sendgrid_account_is_at_risk_for_suspension_what_should_i_do.html">I got an email saying, "Your SendGrid Account Is At Risk For Suspension". What should I do?</a></li>
         </ul>
     </div>
 </div>
diff --git 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)
diff --git 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 %}
 
 <p>
@@ -32,7 +34,7 @@
 
 <ul>
 	<li>An Android device, iPhone, iPod Touch, or iPad with iOS 8 or later</li>
-	<li>A SendGrid account is required. You can sign up on our <a href="{{site.site_url}}/user/signup" target="_blank">website</a> or contact our friendly sales team at 888-985-7363.</li>
+	<li>A SendGrid account is required. If you don't have an account, You can <a href="{{site.site_url}}/user/signup" target="_blank">sign up for one here</a>.</li>
 </ul>
 
 <p style="text-align:center">
diff --git a/source/User_Guide/Transactional_Email/index.html b/source/User_Guide/Transactional_Email/index.html
@@ -25,7 +25,6 @@
 
 <ul>
     <li><a href="{{root_url}}/API_Reference/index.html">API Reference</a></li>
-    <li><a href="{{root_url}}/Utilities/code_workshop.html">Code Workshops</a></li>
     <li><a href="{{root_url}}/Utilities/list_assist.html">List Assist</a></li>
     <li><a href="{{root_url}}/Utilities/smtpapi_validator.html">SMTPAPI Validator</a></li>
 </ul>
diff --git a/source/Utilities/code_workshop.md b/source/Utilities/code_workshop.md
diff --git 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.
 
diff --git a/source/index.html b/source/index.html
@@ -90,7 +90,7 @@ <h3>Event Webhook</h3>
     </a>
   </div>
   <div class="col-md-12">
-    <a href="{{root_url}}/API_Reference/Webhooks/index.html">
+    <a href="{{root_url}}/API_Reference/Webhooks/parse.html">
       <h3>Inbound Parse</h3>
         <p>
           Programmatically parse incoming emails.
