Schedule

このエンドポイントでマーケティングメールのスケジュール配信イベントを追加、閲覧、削除をします。

すぐにマーケティングメールを送信する場合、 atafter パラメータを指定しないでください。

add

作成済みのマーケティングメールに配信スケジュールを作成します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール スケジュール配信するマーケティングメール。(すぐにマーケティングメールを送信する場合、パラメータを指定しないでください)
at No ISO8601フォーマットで日時を指定します(YYYY-mm-dd HH:MM:SS+-HH:MM) スケジュール配信する日時
after No 正の整数 配信開始までの分
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/schedule/add.json
POST Data name=test&at=2013-12-20T11:55:00-05:00&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/schedule/add.xml
POST Data name=test&at=2013-12-20T11:55:00-05:00&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <message>success</message>
</result>

get

作成済みのマーケティングメールの配信予定時刻を取得します。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール マーケティングメールの配信予定時刻を取得します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/schedule/get.json
POST Data name=SendGrid_Test2&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "date": "2012-09-05 21:22:02"
}

Call

POST https://api.sendgrid.com/api/newsletter/schedule/get.xml
POST Data name=SendGrid_Test2&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <message>success</message>
</result>

delete

マーケティングメールの配信予定をキャンセルします。

URI引数 必須 条件 説明
name Yes 作成済みのマーケティングメール 作成済みのマーケティングメールから配信予定時刻を削除します
Parameter Value Requirements Description

Call

POST https://api.sendgrid.com/api/newsletter/schedule/delete.json
POST Data name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
{
  "message": "success"
}

Call

POST https://api.sendgrid.com/api/newsletter/schedule/delete.xml
POST Data name=test&api_user=your_sendgrid_username&api_key=your_sendgrid_password

Response

1
2
3
<result>
   <message>success</message>
</result>