Overview

You can use this request to cancel an email before it is sent.

The Method

API-Method
RESTPOSThttps://[Your URL] /api/2.0/email_actions/cancel/:id

Parameters

You must include the ID of the email in the request.

PropertyTypeDescriptionRequired
$idintegerThe ID of the email.yes

Example Request

<?php
$username = 'administrator';
$apiKey = '7IjRKva9OzwCsy9xaCwsihA6HxUTwE7a_999';
$localUrl = 'https://localhost';

$messageId = 28;
$url = $localUrl . '/api/2.0/email_actions/cancel/' . $messageId;
$method = 'POST';
$auth = base64_encode($username . ':' . $apiKey);

$cSession = curl_init();

curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_POSTFIELDS, '{}');
curl_setopt($cSession, CURLOPT_HTTPHEADER, [
    'Authorization: Basic ' . $auth,
    'Content-Type: application/json'
]);

$response = curl_exec($cSession);
var_dump($response);

curl_close($cSession);

Example Response

{
   "links":[
      {
         "title":"Self",
         "rel":"self",
         "href":"http:\/\/localhost\/api\/2.0\/email_actions\/cancel\/28"
      },
      {
         "title":"Home",
         "rel":"home",
         "href":"http:\/\/localhost\/api\/2.0\/"
      }
   ],
   "boolean":"true"
}