API Reference
Cancel a scheduled email
Cancel one scheduled email before it is sent. This is a soft delete: the status flips to canceled and the record survives; the message is never transmitted. Only a still-scheduled email can be canceled.
DELETE
/
scheduled-emails
/
{id}
Cancel a scheduled email
curl --request DELETE \
--url https://api.mailkube.com/mta/v1/scheduled-emails/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mailkube.com/mta/v1/scheduled-emails/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mailkube.com/mta/v1/scheduled-emails/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mailkube.com/mta/v1/scheduled-emails/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mailkube.com/mta/v1/scheduled-emails/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.mailkube.com/mta/v1/scheduled-emails/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mailkube.com/mta/v1/scheduled-emails/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
"object": "scheduled_email",
"status": "canceled"
}{
"name": "missing_user_agent",
"message": "A User-Agent header is required.",
"statusCode": 400
}{
"name": "invalid_api_key",
"message": "API key is invalid.",
"statusCode": 403
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "invalid_idempotent_request",
"message": "This Idempotency-Key was already used with a different payload.",
"statusCode": 409
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "rate_limit_exceeded",
"message": "Too many requests. Please slow down.",
"statusCode": 429
}{
"name": "application_error",
"message": "An unexpected error occurred.",
"statusCode": 500
}Authorizations
An API key created in the dashboard, sent as Authorization: Bearer mk_....
Headers
A unique key making this write retry-safe. A repeat request with the same key and a byte-identical body returns the original response instead of executing again (24-hour window). Max 256 characters. See Idempotency.
Maximum string length:
256Path Parameters
The scheduled email's id (the platform message UUID returned when it was scheduled).
Cancel a scheduled email
curl --request DELETE \
--url https://api.mailkube.com/mta/v1/scheduled-emails/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.mailkube.com/mta/v1/scheduled-emails/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.mailkube.com/mta/v1/scheduled-emails/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mailkube.com/mta/v1/scheduled-emails/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.mailkube.com/mta/v1/scheduled-emails/{id}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://api.mailkube.com/mta/v1/scheduled-emails/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mailkube.com/mta/v1/scheduled-emails/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "b2c3d4e5-6f70-4a1b-8c2d-3e4f5a6b7c8d",
"object": "scheduled_email",
"status": "canceled"
}{
"name": "missing_user_agent",
"message": "A User-Agent header is required.",
"statusCode": 400
}{
"name": "invalid_api_key",
"message": "API key is invalid.",
"statusCode": 403
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "invalid_idempotent_request",
"message": "This Idempotency-Key was already used with a different payload.",
"statusCode": 409
}{
"name": "validation_error",
"message": "<string>",
"statusCode": 123
}{
"name": "rate_limit_exceeded",
"message": "Too many requests. Please slow down.",
"statusCode": 429
}{
"name": "application_error",
"message": "An unexpected error occurred.",
"statusCode": 500
}