Scheduled Messages

Schedule a message

Schedules a message for dispatch at the absolute ISO-8601 timestamp supplied in scheduledFor. Requires messages:create or the send permission of the channel it sends on, such as email:send. Optional timezone is validated IANA display metadata only and never changes the execution instant.

post/v1/messages/scheduled

Request

  • Base URL: https://api.samva.dev
  • URL: https://api.samva.dev/v1/messages/scheduled
  • Auth: API key in header x-api-key

Request body

scheduledForstring required
timezonestring
idempotencyKeystring nullable
referenceIdstring nullable

Response

Success

idstring required
status'pending' | 'dispatching' | 'paused' | 'dispatched' | 'cancelled' | 'failed' required
scheduledForstring required
timezonestring required
messageIdstring required
idempotencyKeystring nullable required
referenceIdstring nullable required
failureReasonstring nullable required
attemptsnumber required
createdBystring nullable required
actorEmailstring required
memberRolestring required
createdAtstring required
updatedAtstring required

Changes

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