Scheduled Send

Get scheduled message status

Check a scheduled message's state (pending, processing, sent, cancelled, or failed) along with its scheduled, sent, and cancelled times.

get/schedule/{sourceTrackingId}

Request

  • Base URL: https://api.paubox.com/v1/email
  • URL: https://api.paubox.com/v1/email/schedule/{sourceTrackingId}
  • Auth: HTTP bearer

Path parameters

sourceTrackingIdstring required

The sourceTrackingId returned when the message was scheduled

Response

Scheduled message status

sourceTrackingIdstring
scheduledAtstring date-time
state'pending' | 'processing' | 'sent' | 'cancelled' | 'failed'
messageIdinteger
sentAtstring date-time nullable
cancelledAtstring date-time nullable
errorMessagestring nullable

Example response

{
  "sourceTrackingId": "3d38ab13-0af8-4028-bd45-52e882e0d584"
}

Changes

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