From 28c4c8be07d07cfafc43398c02622cbc419b9136 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Tue, 15 Sep 2015 09:00:20 -0600 Subject: [PATCH 01/17] removed last_email_sent_at --- .../Web_API_v3/Advanced_Suppression_Manager/groups.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.md b/source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.md index 34effbe487..24a624cd5d 100644 --- a/source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.md +++ b/source/API_Reference/Web_API_v3/Advanced_Suppression_Manager/groups.md @@ -33,8 +33,7 @@ HTTP/1.1 201 OK { "id":103, "name": "Product Suggestions", - "description": "Suggestions for products our users might like.", - "last_email_sent_at": "NOT IMPLEMENTED" + "description": "Suggestions for products our users might like." } {% endv3response %} {% endapiv3example %} @@ -53,14 +52,12 @@ Retrieve all suppression groups associated with the user. "id": 100, "name": "Newsletters", "description": "Our monthly newsletter.", - "last_email_sent_at": "2014-09-04 01:34:43", "unsubscribes": 400 }, { "id": 101, "name": "Alerts", "description 2": "Emails triggered by user-defined rules.", - "last_email_sent_at": "2012-11-06 09:37:33", "unsubscribes": 1 } ] @@ -80,7 +77,6 @@ Get information on a single suppression group. "id": 100, "name": "Newsletters", "description": "Our monthly newsletter.", - "last_email_sent_at": "2014-09-04 01:34:43", "unsubscribes": 400 } {% endv3response %} @@ -105,8 +101,7 @@ HTTP/1.1 201 OK { "id":103, "name": "Item Suggestions", - "description": "Suggestions for items our users might like.", - "last_email_sent_at": "2014-09-05 03:14:15" + "description": "Suggestions for items our users might like." } {% endv3response %} {% endapiv3example %} From 80cdebcd41c8a056c4c0803f31ef4fb94272b803 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Tue, 15 Sep 2015 23:04:45 -0600 Subject: [PATCH 02/17] Fixed the link --- source/User_Guide/Suppressions/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/User_Guide/Suppressions/index.html b/source/User_Guide/Suppressions/index.html index db5b9c2cd3..d5328b5c88 100644 --- a/source/User_Guide/Suppressions/index.html +++ b/source/User_Guide/Suppressions/index.html @@ -60,5 +60,5 @@ Global Unsubscribes - When a user unsubscribes from everything you might email them.

- Group Unsubscribes - When a user unsubscribes from a specific group of your emails. + Group Unsubscribes - When a user unsubscribes from a specific group of your emails.

From 9ea7812122d85e9a7b7c6d14d9a850bb6dc43215 Mon Sep 17 00:00:00 2001 From: Matt Bernier Date: Tue, 15 Sep 2015 23:07:40 -0600 Subject: [PATCH 03/17] changed the titles --- source/API_Reference/Web_API_v3/Stats/categories.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/API_Reference/Web_API_v3/Stats/categories.md b/source/API_Reference/Web_API_v3/Stats/categories.md index 5261b0400f..7ff9237646 100644 --- a/source/API_Reference/Web_API_v3/Stats/categories.md +++ b/source/API_Reference/Web_API_v3/Stats/categories.md @@ -9,7 +9,7 @@ navigation: Category Stats provide all of your user's email statistics for your categories. {% anchor h2 %} -GET +GET statistics {% endanchor %} Gets email statistics for the given categories. If you don't pass any parameters, the endpoint will return a sum for each category 10 at a time. @@ -130,7 +130,7 @@ HTTP/1.1 200 * * * * * {% anchor h2 %} -GET +GET Sums {% endanchor %} Gets the total sums of each email statistic metric for all categories over the given date range. From d932f71e886b28bb8579a1aa8d12fd1632976157 Mon Sep 17 00:00:00 2001 From: Elmer Thomas Date: Thu, 17 Sep 2015 15:23:16 -0700 Subject: [PATCH 04/17] Example with using an API Key only --- source/Integrate/Code_Examples/java.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/Integrate/Code_Examples/java.md b/source/Integrate/Code_Examples/java.md index ef1ebcb38e..7b3726da77 100644 --- a/source/Integrate/Code_Examples/java.md +++ b/source/Integrate/Code_Examples/java.md @@ -14,7 +14,10 @@ import com.sendgrid.*; public class SendGridExample { public static void main(String[] args) { - SendGrid sendgrid = new SendGrid(api_user, api_key); + + SendGrid sendgrid = new SendGrid(api_key); // recommended + // OR + SendGrid sendgrid = new SendGrid(api_user, api_password); SendGrid.Email email = new SendGrid.Email(); From 97d1e31f650ca11cadae87b6ea51464f7e7c7c6a Mon Sep 17 00:00:00 2001 From: John Cai Date: Tue, 22 Sep 2015 16:16:20 -0700 Subject: [PATCH 05/17] cancel scheduled send --- .../SMTP_API/scheduling_parameters.md | 17 ++++ .../Web_API_v3/BatchID/batchid.apiblueprint | 53 ++++++++++++ .../cancel_scheduled_send.apiblueprint | 80 +++++++++++++++++++ 3 files changed, 150 insertions(+) create mode 100644 source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint create mode 100644 source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint diff --git a/source/API_Reference/SMTP_API/scheduling_parameters.md b/source/API_Reference/SMTP_API/scheduling_parameters.md index e7b7652c25..aed297d69f 100644 --- a/source/API_Reference/SMTP_API/scheduling_parameters.md +++ b/source/API_Reference/SMTP_API/scheduling_parameters.md @@ -61,3 +61,20 @@ To schedule a send request for individual recipients; use `send_each_at` to send ] } {% endcodeblock %} + +To allow for the cancellation of a scheduled send, you must include a batch id with your send. The endpoint for cancellation needs a batch id to cancel with. To generate a valid batch id, use the batch id generation endpoint + +

Example of including a batch_id

+{% codeblock lang:json %} +{ + "to": [ + "", + "john@example.com", + "mike@example.com" + ], + "send_at": [ + 1409348513 + ], + "batch_id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw" +} +{% endcodeblock %} diff --git a/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint b/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint new file mode 100644 index 0000000000..0da958e1f8 --- /dev/null +++ b/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint @@ -0,0 +1,53 @@ +--- +layout: page +weight: 755 +title: Batch ID +navigation: + show: true +--- + +FORMAT: 1A + +# Batch IDs +If the customer sets the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), +it allows for the customer to then cancel a scheduled send based on that batch_id by calling the [Cancel Scheduled Send endpoint]({{root_url}}/API_Reference/Web_API_v3/Cancel_Scheduled_Send/index.html) + +# Group Batch ID Management + +## Batch ID Generation [/mail/batch] +Generate a new Batch ID to associate with scheduled sends + +### Generate Batch ID [POST] + + ++ Request ++ Response 200 (application/json) + + + Body + + { + "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw", + "expiration": 1442945818 + } + +## Validate Batch ID [/mail/batch/] + +### Validate Batch ID [GET] +Validate whether or not a batch id is valid + ++ Request ++ Response 200 (application/json) + + + Body + + { + "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw" + "expiration": 1442945818 + } ++ Response 400 (application/json) + + + Body + + { + "errors":[{"message": "invalid batch id"}] + } diff --git a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint new file mode 100644 index 0000000000..8fc3a187f7 --- /dev/null +++ b/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint @@ -0,0 +1,80 @@ +--- +layout: page +weight: 755 +title: Cancel Scheduled Sends +navigation: + show: true +--- + +FORMAT: 1A + +# Cancel Scheduled Sends +The Cancel Scheduled Sends feature allows the customer to cancel a +scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) +included in the SMTPAPI header. + +# Group Cancel Scheduled Send + +## Manage user scheduled sends [/user/scheduled_send] +A CRUD for managing user scheduled sends + +### Retrieve scheduled send [GET] +Get cancel/paused scheduled send information. + ++ Request + + Body + + { + "id": 23 + } ++ Response 200 (application/json) + + + Body + + { + "id": 23, + "batch_id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", + "status": "cancel" + + } + + + +### Update user scheduled send information [PUT] +Update the status of a scheduled send. + ++ Request + + Body + + { + "id": 24, + "status": "pause" + } ++ Response 204 (application/json) ++ Response 404 + +### Cancel or pause a scheduled send [POST] +Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will +be returned. + ++ Request + + Body + + { + "id": 24, + "status": "pause" + } ++ Response 201 (application/json) ++ Response 400 + +### Delete a cancellation or pause of a scheduled send [DELETE] +Delete the cancellation/pause of a scheduled send. + ++ Request + + Body + + { + "id": 24 + } ++ Response 204 ++ Response 404 From 27e7197cadaf68d8de9979a0b33e1c0c28972c68 Mon Sep 17 00:00:00 2001 From: John Cai Date: Wed, 23 Sep 2015 10:04:16 -0700 Subject: [PATCH 06/17] adding coma --- source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint b/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint index 0da958e1f8..6e5a383486 100644 --- a/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint +++ b/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint @@ -41,7 +41,7 @@ Validate whether or not a batch id is valid + Body { - "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw" + "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw", "expiration": 1442945818 } + Response 400 (application/json) From 223b1f549d0e3231a876c7c230a6585cc70ac3de Mon Sep 17 00:00:00 2001 From: mbernier Date: Wed, 23 Sep 2015 11:39:44 -0600 Subject: [PATCH 07/17] moving files and updated page weight --- .../Web_API_v3/{BatchID => }/batchid.apiblueprint | 8 ++++---- .../cancel_scheduled_send.apiblueprint | 0 2 files changed, 4 insertions(+), 4 deletions(-) rename source/API_Reference/Web_API_v3/{BatchID => }/batchid.apiblueprint (92%) rename source/API_Reference/Web_API_v3/{Cancel_Scheduled_Send => }/cancel_scheduled_send.apiblueprint (100%) diff --git a/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint b/source/API_Reference/Web_API_v3/batchid.apiblueprint similarity index 92% rename from source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint rename to source/API_Reference/Web_API_v3/batchid.apiblueprint index 6e5a383486..ed7d185a20 100644 --- a/source/API_Reference/Web_API_v3/BatchID/batchid.apiblueprint +++ b/source/API_Reference/Web_API_v3/batchid.apiblueprint @@ -1,7 +1,7 @@ --- layout: page -weight: 755 -title: Batch ID +weight: 0 +title: Batch ID navigation: show: true --- @@ -9,7 +9,7 @@ navigation: FORMAT: 1A # Batch IDs -If the customer sets the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), +If the customer sets the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), it allows for the customer to then cancel a scheduled send based on that batch_id by calling the [Cancel Scheduled Send endpoint]({{root_url}}/API_Reference/Web_API_v3/Cancel_Scheduled_Send/index.html) # Group Batch ID Management @@ -47,7 +47,7 @@ Validate whether or not a batch id is valid + Response 400 (application/json) + Body - + { "errors":[{"message": "invalid batch id"}] } diff --git a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint similarity index 100% rename from source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint rename to source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint From a07fae5420eb62a1852260b567657fa87fc6bf78 Mon Sep 17 00:00:00 2001 From: mbernier Date: Wed, 23 Sep 2015 12:59:38 -0600 Subject: [PATCH 08/17] merge the two files and made content changes --- .../cancel_scheduled_send.apiblueprint | 68 ++++++++++++++++--- 1 file changed, 60 insertions(+), 8 deletions(-) diff --git a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint index 8fc3a187f7..8ba3358609 100644 --- a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint +++ b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint @@ -1,22 +1,66 @@ --- layout: page -weight: 755 -title: Cancel Scheduled Sends +weight: 0 +title: Cancel Scheduled Sends navigation: show: true --- FORMAT: 1A +# Batch IDs +If you set the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), +it allows you to then cancel a scheduled send based on that batch_id by calling the [Cancel Scheduled Send endpoint]({{root_url}}/API_Reference/Web_API_v3/cancel_scheduled_send.html#Cancel-Scheduled-Sends) + +# Group Batch ID Management + +## Batch ID Generation [/mail/batch] +Generate a new Batch ID to associate with scheduled sends + +### Generate Batch ID [POST] + ++ Request + + ++ Response 200 (application/json) + + + Body + + { + "id": "YOUR_BATCH_ID", + "expiration": 1442945818 + } + +## Validate Batch ID [/mail/batch/] + +### Validate Batch ID [GET] +Validate whether or not a batch id is valid + ++ Request ++ Response 200 (application/json) + + + Body + + { + "id": "YOUR_BATCH_ID", + "expiration": 1442945818 + } ++ Response 400 (application/json) + + + Body + + { + "errors":[{"message": "invalid batch id"}] + } + + # Cancel Scheduled Sends -The Cancel Scheduled Sends feature allows the customer to cancel a -scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) +The Cancel Scheduled Sends feature allows you to cancel a scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) included in the SMTPAPI header. # Group Cancel Scheduled Send ## Manage user scheduled sends [/user/scheduled_send] -A CRUD for managing user scheduled sends ### Retrieve scheduled send [GET] Get cancel/paused scheduled send information. @@ -27,15 +71,16 @@ Get cancel/paused scheduled send information. { "id": 23 } + + Response 200 (application/json) + Body { "id": 23, - "batch_id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", + "batch_id": "YOUR_BATCH_ID", "status": "cancel" - + } @@ -50,11 +95,13 @@ Update the status of a scheduled send. "id": 24, "status": "pause" } + + Response 204 (application/json) + + Response 404 ### Cancel or pause a scheduled send [POST] -Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will +Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will be returned. + Request @@ -64,17 +111,22 @@ be returned. "id": 24, "status": "pause" } + + Response 201 (application/json) + + Response 400 ### Delete a cancellation or pause of a scheduled send [DELETE] Delete the cancellation/pause of a scheduled send. + Request + + Body { "id": 24 } + + Response 204 + + Response 404 From 053a7ee0237cd99a50b6ae138c6923dde33d2b1f Mon Sep 17 00:00:00 2001 From: mbernier Date: Wed, 23 Sep 2015 13:00:17 -0600 Subject: [PATCH 09/17] removed excess file because merged --- .../Web_API_v3/batchid.apiblueprint | 53 ------------------- 1 file changed, 53 deletions(-) delete mode 100644 source/API_Reference/Web_API_v3/batchid.apiblueprint diff --git a/source/API_Reference/Web_API_v3/batchid.apiblueprint b/source/API_Reference/Web_API_v3/batchid.apiblueprint deleted file mode 100644 index ed7d185a20..0000000000 --- a/source/API_Reference/Web_API_v3/batchid.apiblueprint +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: page -weight: 0 -title: Batch ID -navigation: - show: true ---- - -FORMAT: 1A - -# Batch IDs -If the customer sets the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), -it allows for the customer to then cancel a scheduled send based on that batch_id by calling the [Cancel Scheduled Send endpoint]({{root_url}}/API_Reference/Web_API_v3/Cancel_Scheduled_Send/index.html) - -# Group Batch ID Management - -## Batch ID Generation [/mail/batch] -Generate a new Batch ID to associate with scheduled sends - -### Generate Batch ID [POST] - - -+ Request -+ Response 200 (application/json) - - + Body - - { - "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw", - "expiration": 1442945818 - } - -## Validate Batch ID [/mail/batch/] - -### Validate Batch ID [GET] -Validate whether or not a batch id is valid - -+ Request -+ Response 200 (application/json) - - + Body - - { - "id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw", - "expiration": 1442945818 - } -+ Response 400 (application/json) - - + Body - - { - "errors":[{"message": "invalid batch id"}] - } From ebd07ebe9b32a28864794b9e665954843a415c80 Mon Sep 17 00:00:00 2001 From: John Cai Date: Fri, 25 Sep 2015 11:08:59 -0700 Subject: [PATCH 10/17] changing id to batchid --- .../cancel_scheduled_send.apiblueprint | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint index 8fc3a187f7..d199c40afd 100644 --- a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint +++ b/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint @@ -32,8 +32,7 @@ Get cancel/paused scheduled send information. + Body { - "id": 23, - "batch_id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", + "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", "status": "cancel" } @@ -47,7 +46,7 @@ Update the status of a scheduled send. + Body { - "id": 24, + "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", "status": "pause" } + Response 204 (application/json) @@ -61,7 +60,7 @@ be returned. + Body { - "id": 24, + "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", "status": "pause" } + Response 201 (application/json) @@ -74,7 +73,7 @@ Delete the cancellation/pause of a scheduled send. + Body { - "id": 24 + "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y" } + Response 204 + Response 404 From 9658f52fe82c1b35e58764281256301239693360 Mon Sep 17 00:00:00 2001 From: mbernier Date: Fri, 25 Sep 2015 14:22:29 -0600 Subject: [PATCH 11/17] merged files and deleted extras --- .../cancel_scheduled_send.apiblueprint | 79 ------------- .../cancel_scheduled_send.apiblueprint | 106 +++++++++--------- 2 files changed, 51 insertions(+), 134 deletions(-) delete mode 100644 source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint diff --git a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint deleted file mode 100644 index d199c40afd..0000000000 --- a/source/API_Reference/Web_API_v3/Cancel_Scheduled_Send/cancel_scheduled_send.apiblueprint +++ /dev/null @@ -1,79 +0,0 @@ ---- -layout: page -weight: 755 -title: Cancel Scheduled Sends -navigation: - show: true ---- - -FORMAT: 1A - -# Cancel Scheduled Sends -The Cancel Scheduled Sends feature allows the customer to cancel a -scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) -included in the SMTPAPI header. - -# Group Cancel Scheduled Send - -## Manage user scheduled sends [/user/scheduled_send] -A CRUD for managing user scheduled sends - -### Retrieve scheduled send [GET] -Get cancel/paused scheduled send information. - -+ Request - + Body - - { - "id": 23 - } -+ Response 200 (application/json) - - + Body - - { - "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", - "status": "cancel" - - } - - - -### Update user scheduled send information [PUT] -Update the status of a scheduled send. - -+ Request - + Body - - { - "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", - "status": "pause" - } -+ Response 204 (application/json) -+ Response 404 - -### Cancel or pause a scheduled send [POST] -Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will -be returned. - -+ Request - + Body - - { - "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y", - "status": "pause" - } -+ Response 201 (application/json) -+ Response 400 - -### Delete a cancellation or pause of a scheduled send [DELETE] -Delete the cancellation/pause of a scheduled send. - -+ Request - + Body - - { - "id": "MDI2MmNjN2MtNjE1NS0xMWU1LThkNWItMDgwMDI3OGJkMmY2LTIwZWFkZmI2Y" - } -+ Response 204 -+ Response 404 diff --git a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint index f94b516737..cbea2d5915 100644 --- a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint +++ b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint @@ -54,78 +54,74 @@ Validate whether or not a batch id is valid } -# Cancel Scheduled Sends -The Cancel Scheduled Sends feature allows you to cancel a scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) -included in the SMTPAPI header. + # Cancel Scheduled Sends + The Cancel Scheduled Sends feature allows the customer to cancel a + scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) + included in the SMTPAPI header. -# Group Cancel Scheduled Send + # Group Cancel Scheduled Send -## Manage user scheduled sends [/user/scheduled_send] + ## Manage user scheduled sends [/user/scheduled_send] + A CRUD for managing user scheduled sends -### Retrieve scheduled send [GET] -Get cancel/paused scheduled send information. + ### Retrieve scheduled send [GET] + Get cancel/paused scheduled send information. -+ Request - + Body - - { - "id": "YOUR_BATCH_ID" - } - -+ Response 200 (application/json) - - + Body - - { - "id": "YOUR_BATCH_ID", - "status": "cancel" - - } + + Request + + Body + { + "id": "YOUR_BATCH_ID" + } + + Response 200 (application/json) -### Update user scheduled send information [PUT] -Update the status of a scheduled send. - -+ Request - + Body - - { - "id": "YOUR_BATCH_ID", - "status": "pause" - } + + Body -+ Response 204 (application/json) + { + "id": "YOUR_BATCH_ID", + "status": "cancel" + } -+ Response 404 -### Cancel or pause a scheduled send [POST] -Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will -be returned. -+ Request - + Body + ### Update user scheduled send information [PUT] + Update the status of a scheduled send. - { - "id": "YOUR_BATCH_ID", - "status": "pause" - } + + Request + + Body -+ Response 201 (application/json) + { + "id": "YOUR_BATCH_ID", + "status": "pause" + } + + Response 204 (application/json) + + Response 404 -+ Response 400 + ### Cancel or pause a scheduled send [POST] + Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will + be returned. -### Delete a cancellation or pause of a scheduled send [DELETE] -Delete the cancellation/pause of a scheduled send. + + Request + + Body -+ Request + { + "id": "YOUR_BATCH_ID", + "status": "pause" + } + + Response 201 (application/json) + + Response 400 - + Body + ### Delete a cancellation or pause of a scheduled send [DELETE] + Delete the cancellation/pause of a scheduled send. - { - "id": "YOUR_BATCH_ID" - } + + Request + + Body -+ Response 204 + { + "id": "YOUR_BATCH_ID" + } + + + Response 204 -+ Response 404 + + Response 404 From 3fdba163c187b3c9da931b326acd676917e70b72 Mon Sep 17 00:00:00 2001 From: mbernier Date: Fri, 25 Sep 2015 15:27:55 -0600 Subject: [PATCH 12/17] formatting changes --- .../cancel_scheduled_send.apiblueprint | 124 ++++++++++-------- 1 file changed, 68 insertions(+), 56 deletions(-) diff --git a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint index cbea2d5915..f455852ea6 100644 --- a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint +++ b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint @@ -8,12 +8,11 @@ navigation: FORMAT: 1A -# Batch IDs +# Group Batch IDs + If you set the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), it allows you to then cancel a scheduled send based on that batch_id by calling the [Cancel Scheduled Send endpoint]({{root_url}}/API_Reference/Web_API_v3/cancel_scheduled_send.html#Cancel-Scheduled-Sends) -# Group Batch ID Management - ## Batch ID Generation [/mail/batch] Generate a new Batch ID to associate with scheduled sends @@ -27,24 +26,27 @@ Generate a new Batch ID to associate with scheduled sends + Body { - "id": "YOUR_BATCH_ID", + "batch_id": "YOUR_BATCH_ID", "expiration": 1442945818 } ## Validate Batch ID [/mail/batch/] ### Validate Batch ID [GET] + Validate whether or not a batch id is valid + Request + + Response 200 (application/json) + Body { - "id": "YOUR_BATCH_ID", + "batch_id": "YOUR_BATCH_ID", "expiration": 1442945818 } + + Response 400 (application/json) + Body @@ -54,74 +56,84 @@ Validate whether or not a batch id is valid } - # Cancel Scheduled Sends - The Cancel Scheduled Sends feature allows the customer to cancel a - scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) - included in the SMTPAPI header. +# Group Cancel Scheduled Sends - # Group Cancel Scheduled Send +The Cancel Scheduled Sends feature allows the customer to cancel a +scheduled send based on a [Batch ID]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html) +included in the SMTPAPI header. - ## Manage user scheduled sends [/user/scheduled_send] - A CRUD for managing user scheduled sends +## Manage user scheduled sends [/user/scheduled_send] - ### Retrieve scheduled send [GET] - Get cancel/paused scheduled send information. +A CRUD for managing user scheduled sends - + Request - + Body +### Retrieve scheduled send [GET] - { - "id": "YOUR_BATCH_ID" - } +Get cancel/paused scheduled send information. - + Response 200 (application/json) ++ Request + + Body - + Body + { + "batch_id": "YOUR_BATCH_ID" + } - { - "id": "YOUR_BATCH_ID", - "status": "cancel" - } ++ Response 200 (application/json) + + Body + { + "batch_id": "YOUR_BATCH_ID", + "status": "cancel" + } - ### Update user scheduled send information [PUT] - Update the status of a scheduled send. - + Request - + Body - { - "id": "YOUR_BATCH_ID", - "status": "pause" - } - + Response 204 (application/json) - + Response 404 +### Update user scheduled send information [PUT] - ### Cancel or pause a scheduled send [POST] - Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will - be returned. +Update the status of a scheduled send. - + Request - + Body ++ Request - { - "id": "YOUR_BATCH_ID", - "status": "pause" - } - + Response 201 (application/json) - + Response 400 + + Body - ### Delete a cancellation or pause of a scheduled send [DELETE] - Delete the cancellation/pause of a scheduled send. + { + "batch_id": "YOUR_BATCH_ID", + "status": "pause" + } - + Request - + Body ++ Response 204 (application/json) - { - "id": "YOUR_BATCH_ID" - } - - + Response 204 ++ Response 404 + +### Cancel or pause a scheduled send [POST] + +Cancel or pause a scheduled send. If the maximum number of cancellations/pauses are added, HTTP 400 will +be returned. + ++ Request + + + Body + + { + "batch_id": "YOUR_BATCH_ID", + "status": "pause" + } + ++ Response 201 (application/json) + ++ Response 400 + +### Delete a cancellation or pause of a scheduled send [DELETE] +Delete the cancellation/pause of a scheduled send. + ++ Request + + + Body + + { + "batch_id": "YOUR_BATCH_ID" + } + ++ Response 204 - + Response 404 ++ Response 404 From 951ed089bff0f74257b6470ddb721e64449f3c1c Mon Sep 17 00:00:00 2001 From: John Cai Date: Mon, 28 Sep 2015 12:03:26 -0700 Subject: [PATCH 13/17] fixing docs per changed interface --- .../cancel_scheduled_send.apiblueprint | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint index f455852ea6..797c4d618f 100644 --- a/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint +++ b/source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint @@ -8,6 +8,9 @@ navigation: FORMAT: 1A +# Cancellation of Scheduled Sends +Cancelling scheduled send + # Group Batch IDs If you set the [SMTPAPI header batch_id]({{root_url}}/API_Reference/SMTP_API/scheduling_parameters.html), @@ -26,8 +29,7 @@ Generate a new Batch ID to associate with scheduled sends + Body { - "batch_id": "YOUR_BATCH_ID", - "expiration": 1442945818 + "batch_id": "YOUR_BATCH_ID" } ## Validate Batch ID [/mail/batch/] @@ -43,8 +45,7 @@ Validate whether or not a batch id is valid + Body { - "batch_id": "YOUR_BATCH_ID", - "expiration": 1442945818 + "batch_id": "YOUR_BATCH_ID" } + Response 400 (application/json) @@ -88,7 +89,7 @@ Get cancel/paused scheduled send information. -### Update user scheduled send information [PUT] +### Update user scheduled send information [PATCH] Update the status of a scheduled send. @@ -123,17 +124,13 @@ be returned. + Response 400 +## delete user scheduled send cancellation [/user/scheduled_send/{batch_id}] + ### Delete a cancellation or pause of a scheduled send [DELETE] Delete the cancellation/pause of a scheduled send. + Request - + Body - - { - "batch_id": "YOUR_BATCH_ID" - } - + Response 204 + Response 404 From a298fa29e0df9907cf04e1c73d55cbdbef429e5d Mon Sep 17 00:00:00 2001 From: mbernier Date: Mon, 28 Sep 2015 14:33:55 -0700 Subject: [PATCH 14/17] Updated config file, because it was not reflecting dev changes --- _config.sample.yml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/_config.sample.yml b/_config.sample.yml index 4d4338afd2..b0d952cd19 100644 --- a/_config.sample.yml +++ b/_config.sample.yml @@ -31,9 +31,6 @@ highlighter: pygments # default python pygments have been replaced by pygments.r titlecase: true # Converts page and post titles to titlecase -navigation: #creates a default for showing navigation unless otherwise overridden in individual file's frontmatter - show: true - # list each of the sidebar modules you want to include, in the order you want them to appear. # To add custom asides, create files in /source/_includes/custom/asides/ and add them to the list like 'custom/asides/custom_aside_name.html' default_asides: [asides/page_navigation.html] @@ -54,14 +51,16 @@ asset_pipeline: indextank_api_url: http://:example@example.api.indexden.com #get an index URL at indexden.com indextank_index: docs #set this to the index name you set on indexden.com -# these values are applied as regular expressions -# indextank_excludes: [index.html, 404.html, ^/secret/] +# language +languages: ["en", "es"] +exclude_from_localizations: ["javascript", "images", "css"] #pages we link to from many places, change it once here. Must be added to content as {{root_url}}{{site.thisVariable}} in links password_requirements: "/Classroom/Basics/password.html" app_url: "https://app.sendgrid.com" blog_url: "https://sendgrid.com/blog" marketing_email_url: "https://sendgrid.com/newsletter" +marketing_campaigns_url: "https://sendgrid.com/marketing_campaigns" pricing_url: "https://sendgrid.com/pricing" site_url: "https://sendgrid.com" support_url: "https://support.sendgrid.com" From 848a24e680c0681352421b23fa16655d2521f6db Mon Sep 17 00:00:00 2001 From: mbernier Date: Mon, 28 Sep 2015 14:53:00 -0700 Subject: [PATCH 15/17] Trying to force modernizr to a stable version --- bower.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bower.json b/bower.json index 070e603115..704004787b 100644 --- a/bower.json +++ b/bower.json @@ -25,7 +25,7 @@ "dependencies": { "bootstrap": "~3.1.1", "jquery-ui": "~1.10.4", - "modernizr": ">=2.7.2", + "modernizr": "=2.7.2", "jstorage": "~0.4.8", "jsrender": "~1.0.0-beta", "highlightjs": "~8.0.0", From 266052dec185959f8859550036f827884578156b Mon Sep 17 00:00:00 2001 From: mbernier Date: Mon, 28 Sep 2015 14:54:58 -0700 Subject: [PATCH 16/17] updated to containers at Travis --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 7725d8145e..2463e4f26a 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,5 @@ language: ruby +sudo: false rvm: - 2.1 branches: From 96eaab96bb5a679011e0a0ba0b406e18b289f192 Mon Sep 17 00:00:00 2001 From: mbernier Date: Mon, 28 Sep 2015 14:59:41 -0700 Subject: [PATCH 17/17] adding bundling for Travis --- .travis.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.travis.yml b/.travis.yml index 2463e4f26a..10d19d3650 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,5 +1,6 @@ language: ruby sudo: false +cache: bundler rvm: - 2.1 branches: