From 1cae0faa227cc7a2147d96a7bfa2cdbbbe99df2d Mon Sep 17 00:00:00 2001 From: Brandon West Date: Tue, 1 Jul 2014 17:27:44 -0600 Subject: [PATCH] remove all non-success response examples --- .../Customer_Subuser_API/account_limits.html | 126 ++---------- .../Customer_Subuser_API/apps.html | 35 +--- .../authenticate_a_subuser.html | 26 +-- .../Customer_Subuser_API/invalid_emails.html | 14 +- .../Customer_Subuser_API/ip_management.html | 39 +--- .../Customer_Subuser_API/monitor_records.html | 110 +---------- .../Customer_Subuser_API/parse_settings.html | 66 +------ .../Customer_Subuser_API/subuser_bounces.html | 16 +- .../subuser_spam_reports.html | 16 +- .../subuser_unsubscribes.html | 32 +-- .../Customer_Subuser_API/subusers.html | 158 ++------------- .../Customer_Subuser_API/whitelabel.html | 22 +-- .../Marketing_Emails_API/categories.html | 76 ++----- .../Marketing_Emails_API/emails.html | 69 ++----- .../Marketing_Emails_API/lists.html | 80 ++------ .../Marketing_Emails_API/newsletters.html | 80 ++------ .../Marketing_Emails_API/recipients.html | 57 +----- .../Marketing_Emails_API/schedule.html | 57 +----- .../Marketing_Emails_API/sender_address.html | 97 ++------- .../Marketing_Emails_API/variations.html | 158 +++------------ .../Reseller_API/account_overview.html | 22 +-- source/API_Reference/Reseller_API/apps.html | 35 +--- .../Reseller_API/authenticate_a_customer.html | 22 +-- .../authenticate_a_customer_subuser.html | 22 +-- ...g_retrieving_end_users_invoices_usage.html | 22 +-- .../Reseller_API/customer_account_limits.html | 137 ++----------- .../Reseller_API/customer_bounces.html | 14 +- .../Reseller_API/customer_invalid_emails.html | 14 +- .../Reseller_API/customer_management.html | 186 ++---------------- .../Reseller_API/customer_spam_reports.html | 14 +- .../customer_subuser_account_limits.html | 132 ++----------- .../Reseller_API/customer_subuser_apps.html | 35 +--- .../customer_subuser_bounces.html | 14 +- .../customer_subuser_invalid_emails.html | 14 +- ...stomer_subuser_monitor_outgoing_email.html | 110 +---------- .../customer_subuser_parse_settings.html | 66 +------ .../customer_subuser_spam_reports.html | 14 +- .../customer_subuser_timezone.html | 38 +--- .../customer_subuser_unsubscribes.html | 28 +-- .../Reseller_API/customer_timezone.html | 38 +--- .../Reseller_API/customer_unsubscribes.html | 28 +-- .../Reseller_API/ip_management.html | 45 +---- .../Reseller_API/monitor_records.html | 110 +---------- .../Reseller_API/parse_settings.html | 66 +------ .../Reseller_API/pending_account_changes.html | 167 ++-------------- .../Reseller_API/v1_(deprecated)/apps.html | 26 +-- .../Reseller_API/view_available_packages.html | 22 +-- .../Reseller_API/whitelabel.html | 22 +-- source/API_Reference/Web_API/blocks.html | 38 +--- source/API_Reference/Web_API/bounces.html | 35 +--- .../Web_API/filter_commands.html | 26 +-- .../API_Reference/Web_API/invalid_emails.html | 38 +--- source/API_Reference/Web_API/mail.html | 46 +---- .../Web_API/multiple_credentials.html | 66 ++----- .../API_Reference/Web_API/parse_settings.html | 64 ++---- source/API_Reference/Web_API/profile.html | 96 ++------- .../API_Reference/Web_API/spam_reports.html | 39 +--- .../API_Reference/Web_API/unsubscribes.html | 38 +--- 58 files changed, 429 insertions(+), 2854 deletions(-) diff --git a/source/API_Reference/Customer_Subuser_API/account_limits.html b/source/API_Reference/Customer_Subuser_API/account_limits.html index 24980f1da7..228e7e2701 100644 --- a/source/API_Reference/Customer_Subuser_API/account_limits.html +++ b/source/API_Reference/Customer_Subuser_API/account_limits.html @@ -42,14 +42,7 @@ "last_reset": "2011-02-21" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} 0 @@ -57,17 +50,7 @@ 2011-02-21 - - - - - - error - - ... error messages ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -103,14 +86,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -118,18 +94,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -195,14 +160,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -210,18 +168,7 @@ success@nodes - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -264,14 +211,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -279,13 +219,7 @@ success - -error - ... - ... error messages ... - ... - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -327,14 +261,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -342,18 +269,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -395,14 +311,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -411,17 +320,6 @@ @nodes - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/apps.html b/source/API_Reference/Customer_Subuser_API/apps.html index 1d7f41efdf..c743ea8820 100644 --- a/source/API_Reference/Customer_Subuser_API/apps.html +++ b/source/API_Reference/Customer_Subuser_API/apps.html @@ -107,8 +107,6 @@ {% response json %} {"message":"success","settings":[{"field_name":"field_value"}]} - //empty response - {"settings":"null"} {% endresponse %} {% response xml %} @@ -118,17 +116,7 @@ ... - - - - - error - ... error messages ... - - - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -153,25 +141,8 @@ ] } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - -//empty response -{ - "settings": "null" -} - {% endresponse %} +{% endresponse %} {% response xml %} - -error... error messages ... - - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/authenticate_a_subuser.html b/source/API_Reference/Customer_Subuser_API/authenticate_a_subuser.html index 9aab61b1f5..2baced8cbe 100644 --- a/source/API_Reference/Customer_Subuser_API/authenticate_a_subuser.html +++ b/source/API_Reference/Customer_Subuser_API/authenticate_a_subuser.html @@ -31,14 +31,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -46,20 +39,5 @@ success - - - - - error - - ... - - ... - error messages - ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/invalid_emails.html b/source/API_Reference/Customer_Subuser_API/invalid_emails.html index 70fe6ec2d2..450c5bfcfe 100644 --- a/source/API_Reference/Customer_Subuser_API/invalid_emails.html +++ b/source/API_Reference/Customer_Subuser_API/invalid_emails.html @@ -117,11 +117,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -129,12 +125,6 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/ip_management.html b/source/API_Reference/Customer_Subuser_API/ip_management.html index 4138c72c4b..9bea47e1a3 100644 --- a/source/API_Reference/Customer_Subuser_API/ip_management.html +++ b/source/API_Reference/Customer_Subuser_API/ip_management.html @@ -107,14 +107,7 @@ ] } -//error -{ - "error": { - "code": 400, - "message": "User does not exist" - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -129,13 +122,7 @@ - - - - - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -181,14 +168,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -196,17 +176,6 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/monitor_records.html b/source/API_Reference/Customer_Subuser_API/monitor_records.html index 486ddf5033..acf0af7520 100644 --- a/source/API_Reference/Customer_Subuser_API/monitor_records.html +++ b/source/API_Reference/Customer_Subuser_API/monitor_records.html @@ -54,14 +54,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -69,18 +62,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -134,14 +116,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -149,18 +124,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -196,14 +160,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -211,18 +168,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -330,14 +276,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -345,18 +284,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -392,14 +320,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -407,16 +328,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/parse_settings.html b/source/API_Reference/Customer_Subuser_API/parse_settings.html index 05ff7abb1d..c761af323c 100644 --- a/source/API_Reference/Customer_Subuser_API/parse_settings.html +++ b/source/API_Reference/Customer_Subuser_API/parse_settings.html @@ -111,14 +111,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -126,18 +119,7 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -184,14 +166,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -199,18 +174,7 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -251,14 +215,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -266,16 +223,5 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/subuser_bounces.html b/source/API_Reference/Customer_Subuser_API/subuser_bounces.html index 1e719fe0d1..ddf1f5d7b6 100644 --- a/source/API_Reference/Customer_Subuser_API/subuser_bounces.html +++ b/source/API_Reference/Customer_Subuser_API/subuser_bounces.html @@ -121,24 +121,14 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/subuser_spam_reports.html b/source/API_Reference/Customer_Subuser_API/subuser_spam_reports.html index 0f00587f76..f80f7c887c 100644 --- a/source/API_Reference/Customer_Subuser_API/subuser_spam_reports.html +++ b/source/API_Reference/Customer_Subuser_API/subuser_spam_reports.html @@ -107,25 +107,15 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/subuser_unsubscribes.html b/source/API_Reference/Customer_Subuser_API/subuser_unsubscribes.html index b0b9f3640a..39340ad655 100644 --- a/source/API_Reference/Customer_Subuser_API/subuser_unsubscribes.html +++ b/source/API_Reference/Customer_Subuser_API/subuser_unsubscribes.html @@ -112,26 +112,16 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -174,25 +164,15 @@ "message": "success" } -//error -{ - "message": "Email already exists" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - - - Email already exists - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/subusers.html b/source/API_Reference/Customer_Subuser_API/subusers.html index b415fd1a42..dc103ff33d 100644 --- a/source/API_Reference/Customer_Subuser_API/subusers.html +++ b/source/API_Reference/Customer_Subuser_API/subusers.html @@ -120,14 +120,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -135,13 +128,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -168,14 +155,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -183,13 +163,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -373,11 +347,7 @@ "message": "success" } -//error -{ - "message": "User not found" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -385,13 +355,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -418,11 +382,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "User not found" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -430,13 +390,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -464,11 +418,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "User not found" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -476,13 +426,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -509,11 +453,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "User not found" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -521,13 +461,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -607,14 +541,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -622,13 +549,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -667,14 +588,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -682,13 +596,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -728,14 +636,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -743,13 +644,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -789,14 +684,7 @@ {% response json %} {"message":"success"} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -804,12 +692,6 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Customer_Subuser_API/whitelabel.html b/source/API_Reference/Customer_Subuser_API/whitelabel.html index 66ef2c1dcb..31dd4b071d 100644 --- a/source/API_Reference/Customer_Subuser_API/whitelabel.html +++ b/source/API_Reference/Customer_Subuser_API/whitelabel.html @@ -86,14 +86,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -101,17 +94,6 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/categories.html b/source/API_Reference/Marketing_Emails_API/categories.html index fd8ba472e4..010c62ece4 100644 --- a/source/API_Reference/Marketing_Emails_API/categories.html +++ b/source/API_Reference/Marketing_Emails_API/categories.html @@ -34,19 +34,12 @@ {% apiexample create POST https://api.sendgrid.com/api/newsletter/category/create api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -54,13 +47,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -96,19 +83,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/category/add api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -116,13 +96,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -159,19 +133,12 @@ {% apiexample remove POST https://api.sendgrid.com/api/newsletter/category/remove api_user=your_sendgrid_username&api_key=your_sendgrid_password&category=CATEGORY&name=NEWSLETTER %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -179,13 +146,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -216,7 +177,7 @@ {% apiexample list POST https://api.sendgrid.com/api/newsletter/category/list api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "category": "CATEGORY" @@ -226,14 +187,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -246,13 +200,7 @@ - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/emails.html b/source/API_Reference/Marketing_Emails_API/emails.html index fb06241a83..6cdf59184e 100644 --- a/source/API_Reference/Marketing_Emails_API/emails.html +++ b/source/API_Reference/Marketing_Emails_API/emails.html @@ -21,17 +21,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/lists/email/add list=Test&data=%7B%22email%22%3A%22example%40gmail.com%22%2C%22name%22%3A%22example%22%7D&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "inserted": 1 } -//error -{ - "message": "error", - "error": "error message" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -78,7 +73,7 @@

Examples

{% apiexample get GET https://api.sendgrid.com/api/newsletter/lists/email/get list=Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "email": "dominic.may@sendgrid.com", @@ -86,14 +81,7 @@

Examples

} ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -105,12 +93,7 @@

Examples

- - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -127,34 +110,21 @@

Examples

{% apiexample count GET https://api.sendgrid.com/api/newsletter/lists/email/count list=Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "count": 2 } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 2 - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -172,33 +142,20 @@

Examples

{% apiexample delete POST https://api.sendgrid.com/api/newsletter/lists/email/delete list=Test&email=example%40gmail.com&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "removed": 1 } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 1 - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/lists.html b/source/API_Reference/Marketing_Emails_API/lists.html index 0e936beb3b..2e891ad1d2 100644 --- a/source/API_Reference/Marketing_Emails_API/lists.html +++ b/source/API_Reference/Marketing_Emails_API/lists.html @@ -48,19 +48,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/lists/add list=test789&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -68,14 +61,7 @@ success - - - - - error: reason - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -109,19 +95,12 @@ {% apiexample edit POST https://api.sendgrid.com/api/newsletter/lists/edit list=test7890&newlist=test567&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -129,14 +108,7 @@ success - - - - - error: reason - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -164,21 +136,14 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/lists/get list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "list": "test" } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -188,14 +153,7 @@ - - - - - error: reason - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -223,19 +181,12 @@ {% apiexample delete POST https://api.sendgrid.com/api/newsletter/lists/delete list=test5678&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -243,12 +194,5 @@ success - - - - - error: reason - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/newsletters.html b/source/API_Reference/Marketing_Emails_API/newsletters.html index 5071dcd69d..121b2330f2 100644 --- a/source/API_Reference/Marketing_Emails_API/newsletters.html +++ b/source/API_Reference/Marketing_Emails_API/newsletters.html @@ -55,16 +55,12 @@ {% apiexample create POST https://api.sendgrid.com/api/newsletter/add identity=Sender_Address&name=SendGrid_Test&subject=testsubject&text=testtextbody&html=%3Chtml%3E%3Cp%3Etest_html_body%3C%2Fp%3E%3C%2Fhtml%3E&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ -"error":"error in [parameter]: [parameter] is required" (where [parameter] is from above) -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -72,13 +68,7 @@ success - - - - - error in [parameter]: [parameter] is required (where [parameter] is from above) - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -138,15 +128,12 @@ {% apiexample edit POST https://api.sendgrid.com/api/newsletter/edit identity=Sender_Address&name=SendGrid_Edit_Test&newname=new_name_test&subject=test_subject&text=test_text&html=%3Chtml%3E%3Cp%3ETest_html_text%3C%2Fp%3E%3C%2Fhtml%3E&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error{ - "error":"error in [parameter]: [parameter] is required" (where [parameter] is from above) -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -154,13 +141,7 @@ success - - - - - error in [parameter]: [parameter] is required (where [parameter] is from above) - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -189,7 +170,7 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/get name=SendGrid_Test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "can_edit": true, "name": "SendGrid NL Test", @@ -203,11 +184,7 @@ "subject": null } -//error -{ - "error":"error in [parameter]: [parameter] is required" (where [parameter] is from above) -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -224,13 +201,7 @@ - - - - - error in [parameter]: [parameter] is required (where [parameter] is from above) - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -259,7 +230,7 @@ {% apiexample list POST https://api.sendgrid.com/api/newsletter/list &api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "name": "Just Testing", @@ -278,12 +249,7 @@ "newsletter_id": 38074 } ] -//error -{ - "error":"error in [parameter]: [parameter] is required" (where [parameter] is from above) - -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -306,13 +272,7 @@ - - - - - error in [parameter]: [parameter] is required (where [parameter] is from above) - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -341,16 +301,12 @@ {% apiexample delete POST https://api.sendgrid.com/api/newsletter/delete name=SendGrid_Test1&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "error":"error in [parameter]: [parameter] is required" (where [parameter] is from above) -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -358,11 +314,5 @@ success - - - - - error in [parameter]: [parameter] is required (where [parameter] is from above) - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/recipients.html b/source/API_Reference/Marketing_Emails_API/recipients.html index 3fb5e7aa3a..47b2f9ec38 100644 --- a/source/API_Reference/Marketing_Emails_API/recipients.html +++ b/source/API_Reference/Marketing_Emails_API/recipients.html @@ -43,19 +43,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/recipients/add name=SendGrid%20NL%20Test2&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -63,13 +56,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -104,21 +91,14 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/recipients/get name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "list": "Training Contacts" } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -128,13 +108,7 @@ - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -176,19 +150,12 @@ {% apiexample delete POST https://api.sendgrid.com/api/newsletter/recipients/delete name=SendGrid%20NL%20Test1&list=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -196,12 +163,6 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/schedule.html b/source/API_Reference/Marketing_Emails_API/schedule.html index d40663394b..bf51aa1b3c 100644 --- a/source/API_Reference/Marketing_Emails_API/schedule.html +++ b/source/API_Reference/Marketing_Emails_API/schedule.html @@ -50,19 +50,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/schedule/add name=test&at=2013-12-20T11:55:00-05:00&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -70,13 +63,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -105,19 +92,12 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/schedule/get name=SendGrid_Test2&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "date": "2012-09-05 21:22:02" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -125,15 +105,7 @@ success - - - - - - 2012-09-05 21:22:02 - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -167,14 +139,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -182,12 +147,6 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/sender_address.html b/source/API_Reference/Marketing_Emails_API/sender_address.html index 7c07583edb..3b55b618e7 100644 --- a/source/API_Reference/Marketing_Emails_API/sender_address.html +++ b/source/API_Reference/Marketing_Emails_API/sender_address.html @@ -84,19 +84,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/identity/add identity=Sender_Address1&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Stree&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -104,13 +97,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -199,19 +186,12 @@ {% apiexample edit POST https://api.sendgrid.com/api/newsletter/identity/edit identity=Sender_Address2&newidentity=Sender_Address3&name=Grant&email=grant.hull%40sendgrid.com&address=929_Pearl_Street&city=Boulder&state=Colorado&zip=80302&country=US&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -219,13 +199,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -255,7 +229,7 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/identity/get identity=Sender_Address&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "city": "Boulder", "name": "Name", @@ -268,14 +242,7 @@ "identity": "Sender_Address " } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -291,13 +258,7 @@ Sender_Address - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -329,21 +290,14 @@ {% apiexample list POST https://api.sendgrid.com/api/newsletter/identity/list identity=Sender_Address4&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "identity": "Sender_Address4" } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -351,15 +305,7 @@ success - - - - - - Sender_Address4 - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -390,19 +336,12 @@ {% apiexample delete POST https://api.sendgrid.com/api/newsletter/identity/delete identity=Sender_Address4&api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -410,12 +349,6 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Marketing_Emails_API/variations.html b/source/API_Reference/Marketing_Emails_API/variations.html index 7bbc3ca53f..43662e3262 100644 --- a/source/API_Reference/Marketing_Emails_API/variations.html +++ b/source/API_Reference/Marketing_Emails_API/variations.html @@ -71,19 +71,12 @@ {% apiexample add POST https://api.sendgrid.com/api/newsletter/variations/add api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=variation_name&subject=variation_subject&html=variation_body %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -91,13 +84,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -162,19 +149,12 @@ {% apiexample edit POST https://api.sendgrid.com/api/newsletter/variations/edit api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&type=html&variation=existing_variation_name&newvariation=new_variation_name&subject=variation_subject&html=variation_body %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -182,13 +162,7 @@ success - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -224,7 +198,7 @@ {% apiexample get POST https://api.sendgrid.com/api/newsletter/variations/get api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=existing_variation_name %} {% response json %} -//success + { "name": "existing_variation_name", "timezone_id": null, @@ -238,14 +212,7 @@ "subject": "variation_subject" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} existing_variation_name @@ -260,14 +227,7 @@ variation_subject - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -297,19 +257,12 @@ {% apiexample cancel POST https://api.sendgrid.com/api/newsletter/variations/cancel api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -317,14 +270,7 @@ success - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -361,19 +307,12 @@ {% apiexample delete POST https://api.sendgrid.com/api/newsletter/variations/delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_delete %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -381,14 +320,7 @@ success - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -423,19 +355,12 @@ {% apiexample list POST https://api.sendgrid.com/api/newsletter/variations/list api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_to_find %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -443,14 +368,7 @@ success - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -486,19 +404,12 @@ {% apiexample pickwinner POST https://api.sendgrid.com/api/newsletter/variations/pickwinner api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&variation=variation_that_wins %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -506,14 +417,7 @@ success - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -573,19 +477,12 @@ {% apiexample schedule POST https://api.sendgrid.com/api/newsletter/variations/schedule api_user=your_sendgrid_username&api_key=your_sendgrid_password&name=existing_draft&percent=50 %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -593,14 +490,7 @@ success - - - - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/account_overview.html b/source/API_Reference/Reseller_API/account_overview.html index a9ee25e4c1..0906f5611d 100644 --- a/source/API_Reference/Reseller_API/account_overview.html +++ b/source/API_Reference/Reseller_API/account_overview.html @@ -44,14 +44,7 @@ "billing_process_date": "2010-09-30" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -70,16 +63,5 @@ - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/apps.html b/source/API_Reference/Reseller_API/apps.html index 87f6dc798e..1d3d85de79 100644 --- a/source/API_Reference/Reseller_API/apps.html +++ b/source/API_Reference/Reseller_API/apps.html @@ -192,18 +192,7 @@ ... - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -216,14 +205,7 @@ {% response json %} {"message":"success","settings":[{"field_name":"field_value"}]} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -232,17 +214,6 @@ ... - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/authenticate_a_customer.html b/source/API_Reference/Reseller_API/authenticate_a_customer.html index f5f4d1eec3..f1a364da4a 100644 --- a/source/API_Reference/Reseller_API/authenticate_a_customer.html +++ b/source/API_Reference/Reseller_API/authenticate_a_customer.html @@ -37,14 +37,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -52,16 +45,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/authenticate_a_customer_subuser.html b/source/API_Reference/Reseller_API/authenticate_a_customer_subuser.html index 2729af187f..f328ea065e 100644 --- a/source/API_Reference/Reseller_API/authenticate_a_customer_subuser.html +++ b/source/API_Reference/Reseller_API/authenticate_a_customer_subuser.html @@ -30,14 +30,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -45,16 +38,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html b/source/API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html index 2b2607f116..4f0a7a5e29 100644 --- a/source/API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html +++ b/source/API_Reference/Reseller_API/billing_retrieving_end_users_invoices_usage.html @@ -64,14 +64,7 @@ ] } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -113,17 +106,6 @@ - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_account_limits.html b/source/API_Reference/Reseller_API/customer_account_limits.html index a25a303115..de64049913 100644 --- a/source/API_Reference/Reseller_API/customer_account_limits.html +++ b/source/API_Reference/Reseller_API/customer_account_limits.html @@ -42,14 +42,7 @@ "last_reset": "2011-02-21" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -59,18 +52,7 @@ 2011-02-21 - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -116,14 +98,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -131,19 +106,7 @@ success - - - - - error - - - ... error messages ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -226,14 +189,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -241,19 +197,7 @@ success - - - - - error - - - ... error messages ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -307,14 +251,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -322,19 +259,7 @@ success - - - - - error - - - ... error messages ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -388,14 +313,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -403,19 +321,7 @@ success - - - - - error - - - ... error messages ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -469,14 +375,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -484,17 +383,5 @@ success - - - - - error - - - ... error messages ... - - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_bounces.html b/source/API_Reference/Reseller_API/customer_bounces.html index 8f7fe87afe..2a13b238e1 100644 --- a/source/API_Reference/Reseller_API/customer_bounces.html +++ b/source/API_Reference/Reseller_API/customer_bounces.html @@ -139,11 +139,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -151,12 +147,6 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_invalid_emails.html b/source/API_Reference/Reseller_API/customer_invalid_emails.html index 23c75a34fa..c40f94bcec 100644 --- a/source/API_Reference/Reseller_API/customer_invalid_emails.html +++ b/source/API_Reference/Reseller_API/customer_invalid_emails.html @@ -145,11 +145,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -157,11 +153,5 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_management.html b/source/API_Reference/Reseller_API/customer_management.html index 09d266d909..1baf6f0659 100644 --- a/source/API_Reference/Reseller_API/customer_management.html +++ b/source/API_Reference/Reseller_API/customer_management.html @@ -160,14 +160,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -175,18 +168,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -219,14 +201,7 @@ "message": "success" } -//error -{ - "error": { - "code": 400, - "message": "User does not exist", - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -234,14 +209,7 @@ success - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -434,14 +402,7 @@ "message": "success" } -//error -{ - "error": { - "code": 400, - "message": "User does not exist", - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -449,14 +410,7 @@ success - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -493,26 +447,14 @@ "message": "success" } -//error -{ - "error": { - "code": 400, - "message": "User does not exist", - } -} - {% endresponse %} +{% endresponse %} {% response xml %} success - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -551,12 +493,7 @@ "message": "success" } -//error -{ - "code": 400, - "message": "User does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -564,14 +501,7 @@ success - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -610,12 +540,7 @@ "message": "success" } -//error -{ - "code": 400, - "message": "User does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -623,14 +548,7 @@ success - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -717,14 +635,7 @@ "message": "success" } -//error -{ - "error": { - "code": 400, - "message": "... error message ..." - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -732,14 +643,7 @@ success - - - - - 400 - ... error message ... - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -790,14 +694,7 @@ "message": "success" } -//error -{ - "error": { - "code": 400, - "message": "Missing ... parameter" - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -805,14 +702,7 @@ success - - - - - 400 - Missing ... parameter - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -875,14 +765,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -890,18 +773,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -955,14 +827,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -970,17 +835,6 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_spam_reports.html b/source/API_Reference/Reseller_API/customer_spam_reports.html index fafc01820c..b1c40a7a2d 100644 --- a/source/API_Reference/Reseller_API/customer_spam_reports.html +++ b/source/API_Reference/Reseller_API/customer_spam_reports.html @@ -131,11 +131,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -143,12 +139,6 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_account_limits.html b/source/API_Reference/Reseller_API/customer_subuser_account_limits.html index 4d98643c7c..1fa54fe44e 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_account_limits.html +++ b/source/API_Reference/Reseller_API/customer_subuser_account_limits.html @@ -41,14 +41,7 @@ {% response json %} {"credit":"0","credit_remain":"2000","last_reset":"2011-02-21"} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -58,18 +51,7 @@ 2011-02-21 - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -108,14 +90,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -123,18 +98,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -209,14 +173,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -224,18 +181,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -281,14 +227,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -296,18 +235,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -353,14 +281,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -368,18 +289,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -425,14 +335,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -440,16 +343,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_apps.html b/source/API_Reference/Reseller_API/customer_subuser_apps.html index a493c63f2f..396d6e46de 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_apps.html +++ b/source/API_Reference/Reseller_API/customer_subuser_apps.html @@ -162,18 +162,7 @@ ... - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -186,29 +175,11 @@ {% response json %} {"message":"success","settings":[{"field_name":"field_value"}]} -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} field_value ... - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_bounces.html b/source/API_Reference/Reseller_API/customer_subuser_bounces.html index 415ef62a0f..ef2deaf54e 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_bounces.html +++ b/source/API_Reference/Reseller_API/customer_subuser_bounces.html @@ -125,11 +125,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -137,11 +133,5 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_invalid_emails.html b/source/API_Reference/Reseller_API/customer_subuser_invalid_emails.html index ef2ea41723..91b0b671e5 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_invalid_emails.html +++ b/source/API_Reference/Reseller_API/customer_subuser_invalid_emails.html @@ -127,11 +127,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -139,12 +135,6 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_monitor_outgoing_email.html b/source/API_Reference/Reseller_API/customer_subuser_monitor_outgoing_email.html index 3d955604e0..17cb87b9c4 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_monitor_outgoing_email.html +++ b/source/API_Reference/Reseller_API/customer_subuser_monitor_outgoing_email.html @@ -56,14 +56,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -71,18 +64,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -139,14 +121,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -154,18 +129,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -204,14 +168,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -219,18 +176,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -343,14 +289,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -358,18 +297,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -409,14 +337,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -424,16 +345,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_parse_settings.html b/source/API_Reference/Reseller_API/customer_subuser_parse_settings.html index dadf90cd37..7cdb852024 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_parse_settings.html +++ b/source/API_Reference/Reseller_API/customer_subuser_parse_settings.html @@ -103,14 +103,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -118,18 +111,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -178,14 +160,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -193,18 +168,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -248,14 +212,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -263,16 +220,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_spam_reports.html b/source/API_Reference/Reseller_API/customer_subuser_spam_reports.html index 2c631a346c..a9b2ccbdf7 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_spam_reports.html +++ b/source/API_Reference/Reseller_API/customer_subuser_spam_reports.html @@ -113,11 +113,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -125,11 +121,5 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_timezone.html b/source/API_Reference/Reseller_API/customer_subuser_timezone.html index 8ad9d28245..82d1990727 100755 --- a/source/API_Reference/Reseller_API/customer_subuser_timezone.html +++ b/source/API_Reference/Reseller_API/customer_subuser_timezone.html @@ -129,15 +129,7 @@ "display":"GMT-06:00" } -// error -{ - "error": - { - "code":400, - "message":"User does not exist" - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -148,14 +140,7 @@ GMT-06:00 - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -208,13 +193,7 @@ "message":"success" } -// error -{ - "message":"error", - "errors":["my_new_timezone not supported"] -} - - {% endresponse %} +{% endresponse %} {% response xml %} @@ -222,14 +201,5 @@ success - - - - - error - - my_new_timezone not supported - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_subuser_unsubscribes.html b/source/API_Reference/Reseller_API/customer_subuser_unsubscribes.html index 22ee44d354..5034e84e84 100644 --- a/source/API_Reference/Reseller_API/customer_subuser_unsubscribes.html +++ b/source/API_Reference/Reseller_API/customer_subuser_unsubscribes.html @@ -119,11 +119,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -131,13 +127,7 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -184,11 +174,7 @@ "message": "success" } -//error -{ - "message": "Email already exists" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -196,11 +182,5 @@ success - - - - - Email already exists - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_timezone.html b/source/API_Reference/Reseller_API/customer_timezone.html index 3511c4ace7..6c99bc278a 100755 --- a/source/API_Reference/Reseller_API/customer_timezone.html +++ b/source/API_Reference/Reseller_API/customer_timezone.html @@ -129,15 +129,7 @@ "display":"GMT-06:00" } -// error -{ - "error": - { - "code":400, - "message":"User does not exist" - } -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -148,14 +140,7 @@ GMT-06:00 - - - - - 400 - User does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -208,13 +193,7 @@ "message":"success" } -// error -{ - "message":"error", - "errors":["my_new_timezone not supported"] -} - - {% endresponse %} +{% endresponse %} {% response xml %} @@ -222,14 +201,5 @@ success - - - - - error - - my_new_timezone not supported - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/customer_unsubscribes.html b/source/API_Reference/Reseller_API/customer_unsubscribes.html index 858415c43c..8846c1ddda 100644 --- a/source/API_Reference/Reseller_API/customer_unsubscribes.html +++ b/source/API_Reference/Reseller_API/customer_unsubscribes.html @@ -127,11 +127,7 @@ "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -139,13 +135,7 @@ success - - - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -192,11 +182,7 @@ "message": "success" } -//error -{ - "message": "Email already exists" -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -204,11 +190,5 @@ success - - - - - Email already exists - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/ip_management.html b/source/API_Reference/Reseller_API/ip_management.html index 58954143bb..c631cb58fc 100644 --- a/source/API_Reference/Reseller_API/ip_management.html +++ b/source/API_Reference/Reseller_API/ip_management.html @@ -61,14 +61,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -131,14 +124,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -201,14 +187,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -273,14 +252,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -352,14 +324,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} diff --git a/source/API_Reference/Reseller_API/monitor_records.html b/source/API_Reference/Reseller_API/monitor_records.html index f7af5cdcc5..5adc628537 100644 --- a/source/API_Reference/Reseller_API/monitor_records.html +++ b/source/API_Reference/Reseller_API/monitor_records.html @@ -63,14 +63,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -78,18 +71,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -154,14 +136,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -169,18 +144,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -227,14 +191,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -242,18 +199,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -345,14 +291,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -360,18 +299,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -418,14 +346,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -433,16 +354,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/parse_settings.html b/source/API_Reference/Reseller_API/parse_settings.html index 4a547ef683..251ebe4428 100644 --- a/source/API_Reference/Reseller_API/parse_settings.html +++ b/source/API_Reference/Reseller_API/parse_settings.html @@ -129,14 +129,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -144,18 +137,7 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -212,14 +194,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -227,18 +202,7 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -290,14 +254,7 @@

Response: Empty

"message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -305,16 +262,5 @@

Response: Empty

success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/pending_account_changes.html b/source/API_Reference/Reseller_API/pending_account_changes.html index f69797dc6d..45c40a2d3d 100644 --- a/source/API_Reference/Reseller_API/pending_account_changes.html +++ b/source/API_Reference/Reseller_API/pending_account_changes.html @@ -67,14 +67,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -106,18 +99,7 @@ - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -150,14 +132,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -165,18 +140,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -239,18 +203,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -303,14 +256,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -318,18 +264,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -368,14 +303,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -383,18 +311,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -447,14 +364,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -462,18 +372,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -526,14 +425,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -541,18 +433,7 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -591,14 +472,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -606,16 +480,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/v1_(deprecated)/apps.html b/source/API_Reference/Reseller_API/v1_(deprecated)/apps.html index a8adc8a27e..eab849edcf 100644 --- a/source/API_Reference/Reseller_API/v1_(deprecated)/apps.html +++ b/source/API_Reference/Reseller_API/v1_(deprecated)/apps.html @@ -54,10 +54,10 @@

Response: Success

{% codeblock %} -filters>twitterTwitter +twitterTwitter This plugin allows you to send an email message to twitter0 ... - {% endcodeblock %}

JSON Call

{% requestblock %} @@ -111,7 +111,7 @@

Response: Success

Response: Success

{% codeblock %} -result>success +success {% endcodeblock %}

JSON Call

{% requestblock %} @@ -167,7 +167,7 @@

Response

Response: Success

{% codeblock %} -result>success +success {% endcodeblock %}

JSON Call

{% requestblock %} @@ -194,9 +194,9 @@

XML Call

Response: Success

{% codeblock %} -filter>field_value +field_value ... - {% endcodeblock %}

Response: Error

{% codeblock %} @@ -205,7 +205,7 @@

Response: Error

Return - Empty

This is returned if that filter has no settings or is not enabled.

{% codeblock %} -filter> {% endcodeblock %}

JSON Call

{% requestblock %} @@ -215,7 +215,7 @@

JSON Call

Response: Success

{% codeblock lang:json %} -"message":"success","settings":{"field_name":"field_value"} +{"message":"success","settings":{"field_name":"field_value"}} {% endcodeblock %}

Return - Empty

@@ -237,13 +237,13 @@

XML Call

Response: Success

{% codeblock %} -filter>field_value +field_value ... - {% endcodeblock %}

Response: Error

{% codeblock %} -result>error... error messages ... +error... error messages ... {% endcodeblock %}

Return - Empty

This is returned if that filter has no settings or is not enabled.

@@ -258,7 +258,7 @@

JSON Call

Response: Success

{% codeblock lang:json %} -"message":"success","settings":{"field_name":"field_value"} +{"message":"success","settings":{"field_name":"field_value"}} {% endcodeblock %}

Response: Error

@@ -272,5 +272,5 @@

Response: Error

Return - Empty

This is returned if that filter has no settings or is not enabled.

{% codeblock %} -"settings":null +{"settings":"null"} {% endcodeblock %} diff --git a/source/API_Reference/Reseller_API/view_available_packages.html b/source/API_Reference/Reseller_API/view_available_packages.html index d857eedbeb..97b47aeb64 100644 --- a/source/API_Reference/Reseller_API/view_available_packages.html +++ b/source/API_Reference/Reseller_API/view_available_packages.html @@ -32,14 +32,7 @@ } ] -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -68,16 +61,5 @@ - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Reseller_API/whitelabel.html b/source/API_Reference/Reseller_API/whitelabel.html index 10aa844ee2..26c603a2c8 100644 --- a/source/API_Reference/Reseller_API/whitelabel.html +++ b/source/API_Reference/Reseller_API/whitelabel.html @@ -103,14 +103,7 @@ "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} @@ -118,16 +111,5 @@ success - - - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/blocks.html b/source/API_Reference/Web_API/blocks.html index 017111e62a..1dd4bf8d4b 100644 --- a/source/API_Reference/Web_API/blocks.html +++ b/source/API_Reference/Web_API/blocks.html @@ -74,31 +74,20 @@ {% apiexample delete POST https://api.sendgrid.com/api/blocks.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com%} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 @nodes - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -115,29 +104,18 @@ {% apiexample count GET https://api.sendgrid.com/api/blocks.count api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "count": "4" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample%} diff --git a/source/API_Reference/Web_API/bounces.html b/source/API_Reference/Web_API/bounces.html index 7a577ef770..0f9328a4f2 100644 --- a/source/API_Reference/Web_API/bounces.html +++ b/source/API_Reference/Web_API/bounces.html @@ -104,29 +104,21 @@ {% apiexample delete POST https://api.sendgrid.com/api/bounces.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "Email does not exist" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success @nodes - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -143,30 +135,19 @@ {% apiexample count GET https://api.sendgrid.com/api/bounces.count api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "count": "4" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/filter_commands.html b/source/API_Reference/Web_API/filter_commands.html index 662cf775e0..0f149b96ac 100644 --- a/source/API_Reference/Web_API/filter_commands.html +++ b/source/API_Reference/Web_API/filter_commands.html @@ -145,34 +145,14 @@ ] } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - -//empty - This is returned if that filter has no settings or is not enabled.< -{ - "settings": null -} - {% endresponse %} +{% endresponse %} {% response xml %} - + nick@sendgrid.com - - - error - ... error messages ... - - - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/invalid_emails.html b/source/API_Reference/Web_API/invalid_emails.html index 61cf645072..53ba632a60 100644 --- a/source/API_Reference/Web_API/invalid_emails.html +++ b/source/API_Reference/Web_API/invalid_emails.html @@ -72,33 +72,22 @@ {% apiexample count GET https://api.sendgrid.com/api/invalidemails.count api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "count": 2 } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 2 - - - Error message - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -115,32 +104,21 @@ {% apiexample delete POST https://api.sendgrid.com/api/invalidemails.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/mail.html b/source/API_Reference/Web_API/mail.html index 0c91873e83..d9ddaa395d 100644 --- a/source/API_Reference/Web_API/mail.html +++ b/source/API_Reference/Web_API/mail.html @@ -196,72 +196,38 @@ {% apiexample mail POST https://api.sendgrid.com/api/mail.send api_user=your_sendgrid_username&api_key=your_sendgrid_password&to=destination@example.com&toname=Destination&subject=Example_Subject&text=testingtextbody&from=info@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} success - - - - error - - ... - ... - - @nodes - - {% endresponse %} +{% endresponse %} {% endapiexample %}

Call: Send to Multiple Recipients

{% apiexample multiple POST https://api.sendgrid.com/api/mail.send api_user=your_sendgrid_username&api_key=your_sendgrid_password&to[]=destination@example.com&toname[]=Destination&to[]=destination2@example.com&toname[]=Destination2&subject=Example_Subject&text=testingtextbody&from=info@domain.com false %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} success - - - - error - - ... - ... - - @nodes - - {% endresponse %} +{% endresponse %} {% endapiexample %}
diff --git a/source/API_Reference/Web_API/multiple_credentials.html b/source/API_Reference/Web_API/multiple_credentials.html index 0c2d10ff07..414ec91417 100644 --- a/source/API_Reference/Web_API/multiple_credentials.html +++ b/source/API_Reference/Web_API/multiple_credentials.html @@ -30,7 +30,7 @@ {% apiexample get GET https://api.sendgrid.com/api/credentials/get api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + [ { "id": 4, @@ -50,17 +50,12 @@ } ] -//error -{ - "error": "error reason" -} - - {% endresponse %} +{% endresponse %} {% response xml %} - + 2013-01-21 16:52:01 @@ -86,12 +81,7 @@ - - - error: reason - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -141,29 +131,21 @@ {% apiexample add POST https://api.sendgrid.com/api/credentials/add api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email": 0, "web": 1, "api": 0} %} {% response json %} -//success + { "message": "success" } -//error -{ - "error": "error reason" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -212,29 +194,21 @@ {% apiexample edit POST https://api.sendgrid.com/api/credentials/edit api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name&password=password&permissions={"email": 0, "web": 1, "api": 0} %} {% response json %} -//success + { "message": "success" } -//error -{ - "error": "error reason" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -264,28 +238,20 @@ {% apiexample remove POST https://api.sendgrid.com/api/credentials/remove api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=name %} {% response json %} -//success + { "message": "success" } -//error -{ - "error": "error reason" -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 4 - - - error: reason - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/parse_settings.html b/source/API_Reference/Web_API/parse_settings.html index 6de10d8f13..413e4bf658 100644 --- a/source/API_Reference/Web_API/parse_settings.html +++ b/source/API_Reference/Web_API/parse_settings.html @@ -14,7 +14,7 @@ {% apiexample get GET https://api.sendgrid.com/api/parse.get api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "parse": [ { @@ -25,17 +25,11 @@ ] } -//empty -{ - "parse": [ - - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + www.example.com @@ -44,9 +38,7 @@ - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -87,37 +79,21 @@ {% apiexample set POST https://api.sendgrid.com/api/parse.set api_user=your_sendgrid_username&api_key=your_sendgrid_password&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1 %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -146,35 +122,19 @@ {% apiexample delete POST https://api.sendgrid.com/api/parse.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&hostname=www.example.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/profile.html b/source/API_Reference/Web_API/profile.html index 9c26cb70a3..7219aeaf63 100644 --- a/source/API_Reference/Web_API/profile.html +++ b/source/API_Reference/Web_API/profile.html @@ -141,37 +141,21 @@ {% apiexample set POST https://api.sendgrid.com/api/profile.set api_user=your_sendgrid_username&api_key=your_sendgrid_password&first_name=newFirstName&last_name=&newLastName %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -217,37 +201,21 @@ {% apiexample reset POST https://api.sendgrid.com/api/password.set api_user=your_sendgrid_username&api_key=your_sendgrid_password&password=newPasword&confirm_password=newPassword %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -287,37 +255,21 @@ {% apiexample setusername POST https://api.sendgrid.com/api/profile.setUsername api_user=your_sendgrid_username&api_key=your_sendgrid_password&username=yournewusername@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %}
@@ -357,35 +309,19 @@ {% apiexample setemail POST https://api.sendgrid.com/api/profile.setEmail api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=yournewemail@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - error - - ... - ... error messages ... - ... - - - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/spam_reports.html b/source/API_Reference/Web_API/spam_reports.html index 3fbfe95a96..e91269bedc 100644 --- a/source/API_Reference/Web_API/spam_reports.html +++ b/source/API_Reference/Web_API/spam_reports.html @@ -71,33 +71,22 @@ {% apiexample count GET https://api.sendgrid.com/api/spamreports.count api_user=your_sendgrid_username&api_key=your_sendgrid_password %} {% response json %} -//success + { "count": 2 } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + 2 - - - Error message - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -118,31 +107,19 @@ {% apiexample delete POST https://api.sendgrid.com/api/spamreports.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - - - success - - - Email does not exist + success - {% endresponse %} +{% endresponse %} {% endapiexample %} diff --git a/source/API_Reference/Web_API/unsubscribes.html b/source/API_Reference/Web_API/unsubscribes.html index 3db9692fd0..de4c26f2b0 100644 --- a/source/API_Reference/Web_API/unsubscribes.html +++ b/source/API_Reference/Web_API/unsubscribes.html @@ -54,32 +54,21 @@ {% apiexample delete POST https://api.sendgrid.com/api/unsubscribes.delete api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=emailToDelete@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %} @@ -95,31 +84,20 @@ {% apiexample add POST https://api.sendgrid.com/api/unsubscribes.add api_user=your_sendgrid_username&api_key=your_sendgrid_password&email=email2@domain.com %} {% response json %} -//success + { "message": "success" } -//error -{ - "message": "error", - "errors": [ - "...error messages..." - ] -} - {% endresponse %} +{% endresponse %} {% response xml %} - + success - - - Email does not exist - - {% endresponse %} +{% endresponse %} {% endapiexample %}