Emails

Cancel a scheduled email

Cancel an email that has not been sent yet. Valid while the email is scheduled or queued; returns 409 once it has left for the provider. Requires the email:send scope.

post/v1/emails/{id}/cancel

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/emails/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring required

The email id.

Response

Canceled

objectstring required
idstring required

Example response

{
  "object": "email"
}

Changes

No recorded changes to this operation across all 1 revision of this API.