This repository has been archived by the owner on Aug 27, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 967
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into mako-3486-add-asm-groups-to-display
- Loading branch information
Showing
9 changed files
with
169 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
language: ruby | ||
sudo: false | ||
cache: bundler | ||
rvm: | ||
- 2.1 | ||
branches: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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://:[email protected] #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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
<h4>Example of including a batch_id</h4> | ||
{% codeblock lang:json %} | ||
{ | ||
"to": [ | ||
"<[email protected]>", | ||
"[email protected]", | ||
"[email protected]" | ||
], | ||
"send_at": [ | ||
1409348513 | ||
], | ||
"batch_id": "MWQxZmIyODYtNjE1Ni0xMWU1LWI3ZTUtMDgwMDI3OGJkMmY2LWEzMmViMjYxMw" | ||
} | ||
{% endcodeblock %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
136 changes: 136 additions & 0 deletions
136
source/API_Reference/Web_API_v3/cancel_scheduled_send.apiblueprint
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
--- | ||
layout: page | ||
weight: 0 | ||
title: Cancel Scheduled Sends | ||
navigation: | ||
show: true | ||
--- | ||
|
||
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), | ||
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) | ||
|
||
## 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 | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID" | ||
} | ||
|
||
## Validate Batch ID [/mail/batch/] | ||
|
||
### Validate Batch ID [GET] | ||
|
||
Validate whether or not a batch id is valid | ||
|
||
+ Request | ||
|
||
+ Response 200 (application/json) | ||
|
||
+ Body | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID" | ||
} | ||
|
||
+ Response 400 (application/json) | ||
|
||
+ Body | ||
|
||
{ | ||
"errors":[{"message": "invalid batch id"}] | ||
} | ||
|
||
|
||
# Group 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. | ||
|
||
## 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 | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID" | ||
} | ||
|
||
+ Response 200 (application/json) | ||
|
||
+ Body | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID", | ||
"status": "cancel" | ||
} | ||
|
||
|
||
|
||
### Update user scheduled send information [PATCH] | ||
|
||
Update the status of a scheduled send. | ||
|
||
+ Request | ||
|
||
+ Body | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID", | ||
"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 | ||
|
||
{ | ||
"batch_id": "YOUR_BATCH_ID", | ||
"status": "pause" | ||
} | ||
|
||
+ Response 201 (application/json) | ||
|
||
+ 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 | ||
|
||
+ Response 204 | ||
|
||
+ Response 404 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters