Cancel a scheduled email
Cancel an email that is scheduled and has not been sent yet.
POST
https://app.usenotix.dev/api/v1/emails/{emailId}/cancelNeeds a full access key. Sending access keys cannot call this. Key permissions lists the extra rules some calls have.
Cancel an email that is scheduled and has not been sent yet.
Path parameters
emailIdstringrequired
Headers
Authorizationstringrequired
Bearer followed by your API key.
curl -X POST "https://app.usenotix.dev/api/v1/emails/<emailId>/cancel" \
-H "Authorization: Bearer $NOTIX_API_KEY"
import { Notix } from "notix-js";
const notix = new Notix(process.env.NOTIX_API_KEY);
const { data, error } = await notix.emails.cancel("email_123");
from notix import Notix
notix = Notix() # reads NOTIX_API_KEY
data, _ = notix.emails.cancel("email_123")
use Notix\Notix;
$notix = new Notix(getenv('NOTIX_API_KEY'));
$email = $notix->emails->cancel('email_123');
Response200
{
"emailId": "cm1x8f3k20001qz7v5b9d2e4a"
}