Skip to content
This repository was archived by the owner on Aug 27, 2021. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
43dc395
added undocumented ASM endpoints
eschallock Jun 1, 2016
50e59d8
added new endpoints docs to ASM group
eschallock Jun 6, 2016
e0d0cd5
added ASM endpoint docs
eschallock Jun 6, 2016
085848d
Update index.html
Zaftula Jun 10, 2016
eb12b74
fixed typos in URL and request example
eschallock Jun 13, 2016
598fb5b
Delete your_sendgrid_account_is_at_risk_for_suspension_what_should_i_…
Zaftula Jun 13, 2016
9e5cf47
Remove the link to this page.
Jun 14, 2016
65bd88e
removed link to code workshop
eschallock Jun 14, 2016
2bdc1d5
removed code workshop
eschallock Jun 14, 2016
18881f0
Merge pull request #1933 from sendgrid/eschallock-patch-4
eschallock Jun 14, 2016
d7a81e3
Merge pull request #1934 from sendgrid/eschallock-patch-5
eschallock Jun 14, 2016
ec4c3d3
Merge pull request #1932 from sendgrid/mbernier-patch-3
eschallock Jun 14, 2016
69124e1
copy edits to suppressions endoints
eschallock Jun 14, 2016
df83003
Merge branch 'develop' of https://github.com/sendgrid/docs into add_a…
eschallock Jun 14, 2016
1d6e6ac
Merge branch 'add_asm_endpoints' of https://github.com/sendgrid/docs …
eschallock Jun 14, 2016
91c8e31
Removed link to deleted Classroom article
eschallock Jun 14, 2016
f719c61
Merge pull request #1877 from sendgrid/add_asm_endpoints
eschallock Jun 14, 2016
5bf95ad
Merge pull request #1935 from sendgrid/eschallock-patch-4
eschallock Jun 14, 2016
f8e62bc
Merge pull request #1928 from sendgrid/Zaftula-patch-4
eschallock Jun 14, 2016
8071133
removed extra space in indented frontmatter
eschallock Jun 14, 2016
85b74ce
Merge pull request #1905 from sendgrid/Zaftula-patch-9
eschallock Jun 14, 2016
64122dd
Update spam_traps.md
bhammerquist Jun 15, 2016
8bee74c
Merge pull request #1937 from bhammerquist/patch-24
eschallock Jun 15, 2016
cd0fe10
Corrected Hyperlink
Jun 16, 2016
a7f6648
Merge pull request #1940 from codyjtclark/patch-4
eschallock Jun 16, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion source/API_Reference/Web_API_v3/Suppression_Management/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

{
Expand Down Expand Up @@ -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 %}
Expand Down
124 changes: 121 additions & 3 deletions source/API_Reference/Web_API_v3/Suppression_Management/suppressions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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":"[email protected]",
"group_id": 1,
"group_name": "Weekly News",
"created_at": 1410986704
},
{
"email":"[email protected]",
"group_id": 2,
"group_name": "Daily News",
"created_at": 1411493671
},
{
"email":"[email protected]",
"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
Expand All @@ -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=['[email protected]','[email protected]'] %}
{% v3response %}
HTTP/1.1 201
{"recipient_emails":["[email protected]","[email protected]"]}
{
"recipient_emails": [
"[email protected]",
"[email protected]"
]
}
{% endv3response %}
{% endapiv3example %}

Expand All @@ -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
["[email protected]","[email protected]"]
[
"[email protected]",
"[email protected]"
]
{% endv3response %}
{% endapiv3example %}

Expand All @@ -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": [
"[email protected]",
"[email protected]",
"[email protected]"
]
}
{% endapiv3requestbody %}

{% v3response %}
HTTP/1.1 200

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

{% endv3response %}
{% endapiv3example %}

This file was deleted.

1 change: 0 additions & 1 deletion source/Classroom/Troubleshooting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion source/Glossary/spam_traps.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
16 changes: 9 additions & 7 deletions source/User_Guide/SendGrid_for_Mobile/index.html
Original file line number Diff line number Diff line change
@@ -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>
Expand All @@ -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">
Expand Down
1 change: 0 additions & 1 deletion source/User_Guide/Transactional_Email/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
9 changes: 0 additions & 9 deletions source/Utilities/code_workshop.md

This file was deleted.

2 changes: 0 additions & 2 deletions source/Utilities/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down