From 5a4e183b88fd1b7988a9cf2dc36cb1312477ce2e Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Fri, 29 May 2015 15:56:31 -0600 Subject: [PATCH 1/6] Added delete_all Closes #1118 --- source/API_Reference/Web_API/unsubscribes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API/unsubscribes.md b/source/API_Reference/Web_API/unsubscribes.md index 989f3a0021..d12dcb27fd 100644 --- a/source/API_Reference/Web_API/unsubscribes.md +++ b/source/API_Reference/Web_API/unsubscribes.md @@ -50,7 +50,7 @@ Retrieve a list of Unsubscribes with addresses and optionally with dates. delete {% endanchor %} -Delete an address from the Unsubscribe list. Please note that if no parameters are provided or if empty parameters are provided the ENTIRE list will be removed. +Delete an address from the Unsubscribe list. Use `delete_all=1` in order to delete all addresses from your unsubscribe list. {% parameters delete %} {% parameter email No 'Must be a valid user account email.' 'Unsubscribed email address to remove.' %} From 5eec91726ce99e9f273618a8960f9444474d1175 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Mon, 1 Jun 2015 20:32:52 -0600 Subject: [PATCH 2/6] Delete automatic_login.md --- .../Customer_Subuser_API/automatic_login.md | 43 ------------------- 1 file changed, 43 deletions(-) delete mode 100644 source/API_Reference/Customer_Subuser_API/automatic_login.md diff --git a/source/API_Reference/Customer_Subuser_API/automatic_login.md b/source/API_Reference/Customer_Subuser_API/automatic_login.md deleted file mode 100644 index 09766f692b..0000000000 --- a/source/API_Reference/Customer_Subuser_API/automatic_login.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: page -weight: 30 -title: Automatic iFrame Login -navigation: - show: true ---- -Allow subusers to manage their account from your website using an iframe to our site. - -{% anchor h2 %} -Initial API Call -{% endanchor %} -In order to login your subuser, you need to contact our API to retrieve the unique URL to automatically login your subuser. Then display the generated URL to automatically login your subuser. - -{% parameters geturl %} - {% parameter 'user' 'Yes' 'Subuser must be under your account' 'This is the subuser to automatically login' %} - {% parameter 'password' 'No' 'subuser password' 'Automatically [authenticate]({{root_url}}/API_Reference/Customer_Subuser_API/authenticate_a_subuser.html) the subuser with this API call' %} -{% endparameters %} - -{% apiexample geturl POST https://api.sendgrid.com/apiv2/customer.geturl api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=subuser_username %} - {% response json %} -{ - "params": "al_username=your_sendgrid_username&al_subuser_name=subuser_username&al_hash=aa39649af578679d3a90d2cc43245d56" -} - {% endresponse %} - {% response xml %} - - al_username=your_sendgrid_username=subuser_username=aa39649af578679d3a90d2cc43245d56 - - - {% endresponse %} -{% endapiexample %} - -{% info %} -If you submit the password and we cannot authenticate the user, the params are returned with a NULL al_hash. -{% endinfo %} - -* * * * * - -{% anchor h2 %} -iFrame Usage -{% endanchor %} -Using the parameters returned from the Initial API Call, you can construct the iFrame URL as shown below. {% codeblock %} {% endcodeblock %} From 65b5e80ba7a1c444b48be7a5a9264fe5d2cdefe2 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Mon, 1 Jun 2015 20:33:38 -0600 Subject: [PATCH 3/6] Update _redirects.htaccess --- source/_redirects.htaccess | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_redirects.htaccess b/source/_redirects.htaccess index a75308ae57..f44a794875 100644 --- a/source/_redirects.htaccess +++ b/source/_redirects.htaccess @@ -5,6 +5,7 @@ ####### #forced a redirect file at /API_Reference/Customer_Subuser_API/event_notification_url.html - the following redirect wouldn't take +Redirect 301 /API_Reference/Customer_Subuser_API/automatic_login.html https://sendgrid.com/docs/API_Reference/Customer_Subuser_API/index.html Redirect 301 /API_Reference/Customer_Subuser_API/event_notification_url.html https://sendgrid.com/docs/API_Reference/Customer_Subuser_API/v1_(deprecated)/event_notification_url.html Redirect 301 /API_Reference/Reseller_API/billing_retrieving_as_you_go_usage.html https://sendgrid.com/docs/API_Reference/Reseller_API/v1_(deprecated)/billing_retrieving_as_you_go_usage.html Redirect 301 /API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html https://sendgrid.com/docs/API_Reference/Reseller_API/v1_(deprecated)/billing_retrieving_end_users_invoices_usage.html From e503db4a64b9a52405c04f06ae81dd1e1de2a729 Mon Sep 17 00:00:00 2001 From: iolaru Date: Tue, 2 Jun 2015 17:41:45 +0300 Subject: [PATCH 4/6] Update libraries.md changed sendgrid-sendgrid to sendgrid-django, which is the actual name of the library (the user who reported it was confused by it) --- source/Integrate/libraries.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/Integrate/libraries.md b/source/Integrate/libraries.md index 62484bdae6..1c1d90dc50 100644 --- a/source/Integrate/libraries.md +++ b/source/Integrate/libraries.md @@ -143,7 +143,7 @@ Python - [smtpapi-python](http://github.com/sendgrid/smtpapi-python) *by SendGrid*- Official Python library to create SMTP API headers - [greplin-tornado-sendgrid](https://github.com/Cue/greplin-tornado-sendgrid) *by Daniel Gross* - SendGrid client for Tornado Web Server - [django-sendgrid](https://github.com/RyanBalfanz/django-sendgrid) *by Ryan Balfanz* - SendGrid SMTP API interface for Django -- [sendgrid-sendgrid](https://github.com/elbuo8/sendgrid-django) *by Yamil Asusta* - SendGrid Web API interface for Django +- [sendgrid-django](https://github.com/elbuo8/sendgrid-django) *by Yamil Asusta* - SendGrid Web API interface for Django {% anchor h3 %} Ruby From aaba59fba91cc166dc14449ff1022b7e2292c85b Mon Sep 17 00:00:00 2001 From: mbernier Date: Tue, 2 Jun 2015 09:12:34 -0600 Subject: [PATCH 5/6] removed links to automatic login --- .../Customer_Subuser_API/index.html | 23 ++-- .../v1_(deprecated)/automatic_login.md | 100 ------------------ source/_redirects.htaccess | 1 + 3 files changed, 10 insertions(+), 114 deletions(-) delete mode 100644 source/API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.md diff --git a/source/API_Reference/Customer_Subuser_API/index.html b/source/API_Reference/Customer_Subuser_API/index.html index 12330dcd6e..5d881e7797 100644 --- a/source/API_Reference/Customer_Subuser_API/index.html +++ b/source/API_Reference/Customer_Subuser_API/index.html @@ -9,47 +9,47 @@

Following are brief descriptions of the various API calls needed to manage your subusers, click the API call name for further details:

{% anchor h2 %} -Subuser Management +Subuser Management {% endanchor %}

Retrieve/Create/Enable/Disable your subusers. Change a subuser email address and username

{% anchor h2 %} -Account Limits +Account Limits {% endanchor %}

Manage the rate of emails your subusers are able to send

{% anchor h2 %} -Filter / Apps +Filter / Apps {% endanchor %}

Setup subusers app settings

{% anchor h2 %} -IP Management +IP Management {% endanchor %}

List all IP addresses you have under your account and retrieve details about them

{% anchor h2 %} -Whitelabel +Whitelabel {% endanchor %}

Manage whitelabel settings for your subusers

{% anchor h2 %} -Monitor Records +Monitor Records {% endanchor %}

Make sure your subusers aren't sending out spam by getting a sample of their outgoing messages

{% anchor h2 %} -Statistics +Statistics {% endanchor %}

Statistics regarding your subusers

{% anchor h2 %} -Bounces +Bounces {% endanchor %}

Manage bounce records of your subusers

{% anchor h2 %} -Invalid Emails +Invalid Emails {% endanchor %}

Manage invalid emails of your subusers

@@ -73,9 +73,4 @@ {% endanchor %}

Check subusers password with our system to see if its valid

-{% anchor h2 %} -Automatic iFrame Login -{% endanchor %} -

Allow users to manage your subusers via iframe using our site

-

diff --git a/source/API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.md b/source/API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.md deleted file mode 100644 index fcd5060bae..0000000000 --- a/source/API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -layout: page -weight: 0 -title: Automatic Login -seo: - robots: NOINDEX, FOLLOW -navigation: - show: true ---- - -{% warning %} - This feature is deprecated, please go to the [Version 2]({{root_url}}/API_Reference/Customer_Subuser_API/automatic_login.html) Customer Subuser API Automatic Login page -{% endwarning %} - -
-Allow subusers to manage their account from your website using an iframe to our site. - -{% anchor h2 %} -Initial API Call -{% endanchor %} -In order to login your subuser, you need to contact our web API to retrieve the unique URL to automatically login your subuser. Then display the generated URL to automatically login your subuser. - - - - - - - - - - - - - - - - - - - - - - -
ParameterRequiredRequirementsDescription
userYesMust be set in email formatThis is the subuser you will attempt to automatically login
passwordNoYour subuser password.Authenticate the subuser with this API call.
- -{% xmljsontabs call %} -{% requestblock %} - - {% requesturl POST %}https://api.sendgrid.com/api/user.geturl.xml - {% endrequesturl %} - - {% requestdata Data POST %}api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com - {% endrequestdata %} - -{% endrequestblock %} - -### Response - -{% codeblock lang:xml %} - - - - al_username=username=example@example.com=b478ab36ebc306990dd283b1c341898e - - -{% endcodeblock %} - -
-
-### Call - -{% requestblock %} - - {% requesturl POST %}https://api.sendgrid.com/api/user.geturl.json - {% endrequesturl %} - - {% requestdata Data POST %}api_user=your_sendgrid_username&api_key=your_sendgrid_password&user=example@example.com - {% endrequestdata %} - -{% endrequestblock %} - -### Response - -{% codeblock lang:json %} -{ - "params": "al_username=username&al_subuser_name=example@example.com&al_hash=aa39649af578679d3a90d2cc43245d56" -} -{% endcodeblock %} - -
- - -* * * * * - -{% anchor h2 %} -iFrame Usage -{% endanchor %} -Using the parameters returned from the Initial API Call, you can construct the iFrame URL as shown below. {% codeblock %} {% endcodeblock %} - - diff --git a/source/_redirects.htaccess b/source/_redirects.htaccess index a75308ae57..82d30d4d80 100644 --- a/source/_redirects.htaccess +++ b/source/_redirects.htaccess @@ -6,6 +6,7 @@ #forced a redirect file at /API_Reference/Customer_Subuser_API/event_notification_url.html - the following redirect wouldn't take Redirect 301 /API_Reference/Customer_Subuser_API/event_notification_url.html https://sendgrid.com/docs/API_Reference/Customer_Subuser_API/v1_(deprecated)/event_notification_url.html +Redirect 301 /API_Reference/Customer_Subuser_API/v1_(deprecated)/automatic_login.html https://sendgrid.com/docs/API_Reference/Customer_Subuser_API/index.html Redirect 301 /API_Reference/Reseller_API/billing_retrieving_as_you_go_usage.html https://sendgrid.com/docs/API_Reference/Reseller_API/v1_(deprecated)/billing_retrieving_as_you_go_usage.html Redirect 301 /API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html https://sendgrid.com/docs/API_Reference/Reseller_API/v1_(deprecated)/billing_retrieving_end_users_invoices_usage.html Redirect 301 /API_Reference/Reseller_API/customer_subuser_account_limits.html https://sendgrid.com/docs/API_Reference/Reseller_API/v1_(deprecated)/customer_account_limits.html From 4601745a16447edef38edf0956565d971dab2489 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Tue, 2 Jun 2015 11:09:21 -0600 Subject: [PATCH 6/6] Updated description --- source/API_Reference/Web_API/mail.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API/mail.md b/source/API_Reference/Web_API/mail.md index 4d6b5c4fd5..6ac01d6e11 100644 --- a/source/API_Reference/Web_API/mail.md +++ b/source/API_Reference/Web_API/mail.md @@ -35,7 +35,7 @@ SendGrid's [API Keys]({{root_url}}/User_Guide/Account/api_keys.html) should be u Send email. {% parameters mail %} - {% parameter 'to' 'Yes' 'Must be a valid email address' 'This can also be passed in as an array, to send to multiple locations. Example: to[]=a@mail.com[]=b@mail.com. Note that recipients passed in this parameter will be visible as part of the message. If you wish to hide the recipients, use the TO parameter in the [x-smtpapi]({{root_url}}/API_Reference/SMTP_API/index.html) header.' %} + {% parameter 'to' 'Yes' 'Must be a valid email address' 'This can also be passed in as an array, to send to multiple locations. Example: to[]=a@mail.com&to[]=b@mail.com. Note that recipients passed in this parameter will be visible as part of the message. If you wish to hide the recipients, use the TO parameter in the [x-smtpapi]({{root_url}}/API_Reference/SMTP_API/index.html) header.' %} {% parameter 'toname' 'No' 'Must be a string. If *to* parameter is an array, *toname* must be an array with the exact number of array elements as the *to* field' 'Give a name to the recipient. This can also be passed as an array if the to above is an array. Example: toname[]=Alpha[]=Beta.' %} {% parameter 'x-smtpapi' 'No' 'Must be in valid JSON format' 'Please review the [SMTP API]({{root_url}}/API_Reference/SMTP_API/index.html) to view documentation on what you can do with the JSON headers' %} {% parameter 'subject' 'Yes' 'Must be a valid string' 'The subject of your email' %}