JavaScript Requires Chilkat v11.0.0+
JavaScript
SendGrid: Schedule a reminder and cancel it by batch ID
See more SendGrid Examples
Schedule a reminder one hour from now. Save its batch ID when it is allocated. If the appointment is canceled, use that saved ID in the cancellation branch. Mail Send accepts a Unix timestamp up to 72 hours ahead; cancel at least 10 minutes before the send time. Cancellation applies to the entire batch.
Create a batch ID ยท Cancel a batch
Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat
v11.4.0 or greater.
var success = false;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
success = false;
var http = new CkHttp();
http.RequireSslCertVerify = true;
// Supply your API key from protected configuration; AuthToken adds the Bearer prefix.
http.AuthToken = "SENDGRID_API_KEY";
var resp = new CkHttpResponse();
// On cancellation, set this to the batch ID saved with the original appointment.
// This branch does not create a new batch or send another reminder.
var batchToCancel = "";
if (batchToCancel !== "") {
var cancellation = new CkJsonObject();
cancellation.UpdateString("batch_id",batchToCancel);
cancellation.UpdateString("status","cancel");
success = http.HttpJson("POST","https://api.sendgrid.com/v3/user/scheduled_sends",cancellation,"application/json",resp);
if (success !== true) {
if (resp.StatusCode == 0) {
console.log(http.LastErrorText);
}
else {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
}
return;
}
if (resp.StatusCode !== 201) {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
return;
}
console.log("Batch cancellation accepted.");
return;
}
success = http.HttpNoBody("POST","https://api.sendgrid.com/v3/mail/batch",resp);
if (success !== true) {
if (resp.StatusCode == 0) {
console.log(http.LastErrorText);
}
else {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
}
return;
}
if (resp.StatusCode !== 201) {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
return;
}
var batch = new CkJsonObject();
success = batch.Load(resp.BodyStr);
if (success !== true) {
console.log("Unexpected response: expected JSON.");
return;
}
var batchId = batch.StringOf("batch_id");
if (batch.HasMember("batch_id") !== true) {
console.log("Missing batch_id in response.");
return;
}
// Allocate one batch per independently cancelable appointment.
console.log("Save this batch ID with the appointment: " + batchId);
var sendTime = new CkDateTime();
sendTime.SetFromCurrentSystemTime();
sendTime.AddSeconds(3600);
var message = new CkJsonObject();
message.UpdateString("batch_id",batchId);
message.UpdateInt("send_at",sendTime.GetAsUnixTime(false));
message.UpdateString("from.email","sender@example.com");
message.UpdateString("personalizations[0].to[0].email","recipient@example.com");
message.UpdateString("subject","Appointment reminder");
message.UpdateString("content[0].type","text/plain");
message.UpdateString("content[0].value","Your appointment is tomorrow at 9:30 AM Central.");
success = http.HttpJson("POST","https://api.sendgrid.com/v3/mail/send",message,"application/json",resp);
if (success !== true) {
if (resp.StatusCode == 0) {
console.log(http.LastErrorText);
}
else {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
}
return;
}
if (resp.StatusCode !== 202) {
console.log("HTTP " + resp.StatusCode + ": " + resp.BodyStr);
return;
}
console.log("Reminder scheduled for " + sendTime.GetAsTimestamp(false));