Cancel Scheduled Sends

スケジュール配信のキャンセル

Batch IDs

SMTP APIで指定したバッチIDを、Cancel Scheduled Sendエンドポイントに渡すとスケジュール配信をキャンセルすることができます。

Generate Batch ID [POST]

バッチIDの生成

Request

1
POST https://api.sendgrid.com/v3/mail/batch HTTP/1.1

Response

1
2
3
4
HTTP/1.1 201
{
  "batch_id": "YOUR_BATCH_ID"
}

Validate Batch ID [GET]

バッチIDの有効性チェック
URI引数 必須 条件 説明
batch_id Yes string チェック対象のバッチID
Example: HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi

Request

1
GET https://api.sendgrid.com/v3/mail/batch/{batch_id} HTTP/1.1

Response

1
2
3
4
HTTP/1.1 200
{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}
URI引数 必須 条件 説明
batch_id Yes string チェック対象のバッチID
Example: HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi

Request

1
GET https://api.sendgrid.com/v3/mail/batch/{batch_id} HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
HTTP/1.1 400
{
  "errors": [
    {
      "field": null,
      "message": "invalid batch id"
    }
  ]
}

Cancel Scheduled Sends

スケジュール配信のキャンセル機能により、バッチIDをX-SMTPAPIに含めることによりスケジュール指定したメールの配信をキャンセルできるようになります。システムの都合上、配信予定時刻の10分以内にキャンセル指定されたメールは実際に配信がキャンセルされる保証はありません。

バッチIDは最大10まで持つことができます。言い換えると、一度にキャンセルすることができるのは10回分のスケジュール配信までとなります。

キャンセルまたは一時停止の指定レコード数が上限を超えた場合、HTTP 400の応答が返ります。

Cancel or pause a scheduled send [POST]

スケジュール配信されたメールをキャンセルまたは一時停止します。

Request

1
POST https://api.sendgrid.com/v3/user/scheduled_sends HTTP/1.1
Request Body
1
2
3
4
{
  "batch_id": "YOUR_BATCH_ID",
  "status": "pause"
}

Response

1
HTTP/1.1 201
1
HTTP/1.1 400

発生しうる 400 エラーメッセージ

フィールド エラーメッセージ
max limit reached(上限に達しました)
batch_idinvalid batch id(不正なバッチIDです)
batch_ida status for this batch id exists, try PATCH to update the status(このバッチIDのステータスが存在します。ステータスを更新する場合はPATCHを試してください)

Retrieve all scheduled sends [GET]

キャンセルおよび一時停止されたスケジュール配信情報をすべて取得します。

Request

1
GET https://api.sendgrid.com/v3/user/scheduled_sends HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
HTTP/1.1 200
[
  {
    "batch_id": "BATCH_ID_1",
    "status": "cancel"
  },
  {
    "batch_id": "BATCH_ID_2",
    "status": "pause"
  }
]

Retrieve a scheduled send [GET]

キャンセルまたは一時停止されたスケジュール配信情報を取得します。

Request

1
GET https://api.sendgrid.com/v3/user/scheduled_sends/{batch_id} HTTP/1.1

Response

1
2
3
4
5
6
7
HTTP/1.1 200
[
  {
    "batch_id": "BATCH_ID_1",
    "status": "cancel"
  }
]

Update user scheduled send information [PATCH]

スケジュール配信のステータスを更新します。

Request

1
PATCH https://api.sendgrid.com/v3/user/scheduled_sends/{batch_id} HTTP/1.1
Request Body
1
2
3
{
  "status": "pause"
}

Response

1
HTTP/1.1 204
1
HTTP/1.1 404

発生しうる 404 エラーメッセージ

フィールド エラーメッセージ
batch id not found(バッチIDが見つかりません)

Delete a cancellation or pause of a scheduled send [DELETE]

キャンセルまたは一時停止レコードを削除します。

Request

1
DELETE https://api.sendgrid.com/v3/user/scheduled_sends/{batch_id} HTTP/1.1

Response

1
HTTP/1.1 204
1
HTTP/1.1 404

発生しうる 404 エラーメッセージ

フィールド エラーメッセージ
batch id not found(バッチIDが見つかりません)