PowerShell Requires Chilkat v11.0.0+
PowerShell
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
Chilkat PowerShell Downloads
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
$success = $false
# Assumes Chilkat is unlocked. See Global Unlock Sample.
$success = $false
$http = New-Object Chilkat.Http
$http.RequireSslCertVerify = $true
# Supply your API key from protected configuration; AuthToken adds the Bearer prefix.
$http.AuthToken = "SENDGRID_API_KEY"
$resp = New-Object Chilkat.HttpResponse
# 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.
$batchToCancel = ""
if ($batchToCancel -ne "") {
$cancellation = New-Object Chilkat.JsonObject
$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 -ne $true) {
if ($resp.StatusCode -eq 0) {
$($http.LastErrorText)
}
else {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
}
exit
}
if ($resp.StatusCode -ne 201) {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
exit
}
$("Batch cancellation accepted.")
exit
}
$success = $http.HttpNoBody("POST","https://api.sendgrid.com/v3/mail/batch",$resp)
if ($success -ne $true) {
if ($resp.StatusCode -eq 0) {
$($http.LastErrorText)
}
else {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
}
exit
}
if ($resp.StatusCode -ne 201) {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
exit
}
$batch = New-Object Chilkat.JsonObject
$success = $batch.Load($resp.BodyStr)
if ($success -ne $true) {
$("Unexpected response: expected JSON.")
exit
}
$batchId = $batch.StringOf("batch_id")
if ($batch.HasMember("batch_id") -ne $true) {
$("Missing batch_id in response.")
exit
}
# Allocate one batch per independently cancelable appointment.
$("Save this batch ID with the appointment: " + $batchId)
$sendTime = New-Object Chilkat.CkDateTime
$sendTime.SetFromCurrentSystemTime()
$sendTime.AddSeconds(3600)
$message = New-Object Chilkat.JsonObject
$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 -ne $true) {
if ($resp.StatusCode -eq 0) {
$($http.LastErrorText)
}
else {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
}
exit
}
if ($resp.StatusCode -ne 202) {
$("HTTP " + $resp.StatusCode + ": " + $resp.BodyStr)
exit
}
$("Reminder scheduled for " + $sendTime.GetAsTimestamp($false))