FlaresendDocs
Emails

Reschedule an email

Move a scheduled email to a new send time.

PATCH/v1/emails/{id}API key

Changes scheduledAt on an email that is still scheduled. The only thing you can change is the time; to change the content, cancel it and send a new one.

A new email.scheduled event is added to the timeline with { "scheduledAt": "…", "rescheduled": true }.

Path parameters

idstringpathrequired

The email ID.

Body parameters

scheduledAtstringrequired

The new send time, an ISO 8601 date-time with a time zone offset. Must be in the future and at most 30 days from now.

Response

The full email, in the same shape as Retrieve an email, with the new scheduledAt.

Errors

StatusCodeWhen
400invalid_bodyscheduledAt is missing or not a date-time with an offset.
400invalid_scheduleThe new time is in the past or more than 30 days ahead.
404email_not_foundNo email with that ID in this project.
409not_cancelableThe email isn't scheduled any more, for example because it's already being sent.