Fetch scheduled emails by batchId or messageId
GET {{baseUrl}}/smtp/emailStatus/:identifier?startDate=2022-02-02&endDate=2022-03-02&sort=desc&status=queued&limit=100&offset=0
Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startDate | string | Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date. | |
endDate | string | Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month. | |
sort | string | Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed. Not valid when identifier is messageId. | |
status | string | Filter the records by status of the scheduled email batch or message. Not valid when identifier is messageId. | |
limit | number | Number of documents returned per page. Not valid when identifier is messageId. | |
offset | number | Index of the first document on the page. Not valid when identifier is messageId. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"count":3,"batches":[{"scheduledAt":"2022-02-28T11:36:43.576000000Z","createdAt":"2022-02-26T11:36:43.576000000Z","status":"queued"},{"scheduledAt":"2022-02-25T11:36:43.576000000Z","createdAt":"2022-02-24T11:36:43.576000000Z","status":"processed"},{"scheduledAt":"2022-02-26T11:36:43.576000000Z","createdAt":"2022-02-25T11:36:43.576000000Z","status":"inProgress"}]}