Emails

Reschedule or cancel a scheduled email

patch/emails/{id}

Request

  • Base URL: https://api.groundmail.dev
  • URL: https://api.groundmail.dev/emails/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Public message ID (msg_…)

Request body

scheduled_atstring date-time
scheduledAtstring date-time

Alias for scheduled_at.

cancelboolean

Response

Scheduled email updated

idstring required

Public message ID (msg_…)

statusstring required

held when content scanning stopped the email for review before sending (new senders only); you get email.delivered or email.failed once it is reviewed.

testtrue

Present (and true) on a test send: a test key (gm_test_…) or only simulator addresses. Nothing was delivered; the outcome and webhooks are simulated.

Example response

{
  "status": "sent"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.